@Generated public class Field98E extends Field implements Serializable, DateContainer, GenericField
String
Calendar
Calendar
Number
Currency
Calendar
Modifier and Type | Field and Description |
---|---|
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 Integer |
DECIMALS
Component number for the Decimals subfield
|
static String |
F_98E
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 98E
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static Integer |
SIGN
Component number for the Sign subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
TIME
Component number for the Time subfield
|
static Integer |
UTC_INDICATOR
Component number for the UTC Indicator subfield
|
components
Constructor and Description |
---|
Field98E()
Default constructor.
|
Field98E(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field98E(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 Field98E |
get(SwiftMessage msg)
Get the first instance of Field98E in the given message.
|
static Field98E |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field98E> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field98E in the given message
an empty list is returned if none found.
|
static List<Field98E> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field98E from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
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
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
String |
getComponent5()
Get the component5
|
Currency |
getComponent5AsCurrency()
Get the component5 as Currency
|
String |
getComponent6()
Get the component6
|
Calendar |
getComponent6AsCalendar()
Get the component6 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 (component2).
|
Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
String |
getDecimals()
Get the Decimals (component4).
|
Number |
getDecimalsAsNumber()
Get the Decimals (component4) as Number
|
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 |
getSign()
Get the Sign (component5).
|
Currency |
getSignAsCurrency()
Get the Sign (component5) as Currency
|
String |
getTime()
Get the Time (component3).
|
Calendar |
getTimeAsCalendar()
Get the Time (component3) as Calendar
|
String |
getUTCIndicator()
Get the UTC Indicator (component6).
|
Calendar |
getUTCIndicatorAsCalendar()
Get the UTC Indicator (component6) 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 Field98E |
newInstance(Field98E 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() |
Field98E |
setComponent1(String component1)
Set the component1.
|
Field98E |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field98E |
setComponent2(String component2)
Set the component2.
|
Field98E |
setComponent3(Calendar component3)
Set the component3 from a Calendar object.
|
Field98E |
setComponent3(String component3)
Set the component3.
|
Field98E |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field98E |
setComponent4(String component4)
Set the component4.
|
Field98E |
setComponent5(Currency component5)
Set the component5 from a Currency object.
|
Field98E |
setComponent5(String component5)
Set the component5.
|
Field98E |
setComponent6(Calendar component6)
Set the component6 from a Calendar object.
|
Field98E |
setComponent6(String component6)
Set the component6.
|
Field98E |
setDate(Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field98E |
setDate(String component2)
Set the Date (component2).
|
Field98E |
setDecimals(Number component4)
Set the Decimals (component4) from a Number object.
|
Field98E |
setDecimals(String component4)
Set the Decimals (component4).
|
Field98E |
setQualifier(String component1)
Set the Qualifier (component1).
|
Field98E |
setSign(Currency component5)
Set the Sign (component5) from a Currency object.
|
Field98E |
setSign(String component5)
Set the Sign (component5).
|
Field98E |
setTime(Calendar component3)
Set the Time (component3) from a Calendar object.
|
Field98E |
setTime(String component3)
Set the Time (component3).
|
Field98E |
setUTCIndicator(Calendar component6)
Set the UTC Indicator (component6) from a Calendar object.
|
Field98E |
setUTCIndicator(String component6)
Set the UTC Indicator (component6).
|
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, 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, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_98E
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer DATE
public static final Integer TIME
public static final Integer DECIMALS
public static final Integer SIGN
public static final Integer UTC_INDICATOR
public static final Integer CONDITIONAL_QUALIFIER
public Field98E()
public Field98E(String value)
value
- complete field value including separators and CRLFpublic Field98E(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 Field98E newInstance(Field98E 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 public String getComponent1AsString()
public String getQualifier()
public Field98E setComponent1(String component1)
component1
- the component1 to setpublic Field98E setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field98E setComponent2(String component2)
component2
- the component2 to setpublic Field98E setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field98E setDate(String component2)
component2
- the Date to setpublic Field98E setDate(Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public String getComponent3()
public Calendar getComponent3AsCalendar()
null
if cannot be convertedpublic String getTime()
public Calendar getTimeAsCalendar()
null
if cannot be convertedpublic Field98E setComponent3(String component3)
component3
- the component3 to setpublic Field98E setComponent3(Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field98E setTime(String component3)
component3
- the Time to setpublic Field98E setTime(Calendar component3)
component3
- Calendar with the Time content to setsetComponent3(java.util.Calendar)
public String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getDecimals()
public Number getDecimalsAsNumber()
null
if cannot be convertedpublic Field98E setComponent4(String component4)
component4
- the component4 to setpublic Field98E setComponent4(Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field98E setDecimals(String component4)
component4
- the Decimals to setpublic Field98E setDecimals(Number component4)
component4
- Number with the Decimals content to setsetComponent4(java.lang.Number)
public String getComponent5()
public Currency getComponent5AsCurrency()
null
if cannot be convertedpublic String getSign()
public Currency getSignAsCurrency()
null
if cannot be convertedpublic Field98E setComponent5(String component5)
component5
- the component5 to setpublic Field98E setComponent5(Currency component5)
component5
- the Currency with the component5 content to setpublic Field98E setSign(String component5)
component5
- the Sign to setpublic Field98E setSign(Currency component5)
component5
- Currency with the Sign content to setsetComponent5(java.util.Currency)
public String getComponent6()
public Calendar getComponent6AsCalendar()
null
if cannot be convertedpublic String getUTCIndicator()
public Calendar getUTCIndicatorAsCalendar()
null
if cannot be convertedpublic Field98E setComponent6(String component6)
component6
- the component6 to setpublic Field98E setComponent6(Calendar component6)
component6
- the Calendar with the component6 content to setpublic Field98E setUTCIndicator(String component6)
component6
- the UTC Indicator to setpublic Field98E setUTCIndicator(Calendar component6)
component6
- Calendar with the UTC Indicator content to setsetComponent6(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 Field98E get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field98E get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field98E> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field98E> 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)