@Generated public class Field98H extends Field implements java.io.Serializable
Model and parser for field 98H of a SWIFT MT message.
Subfields (components) Data types
Calendar
Number
Currency
Calendar
Structure definition
<TIME2>[,3n][/[<N>]<TIME3>]
<TIME2>[,S][/[c]<TIME3>]
TNCW
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_98H
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
N
Component number for the N subfield
|
static java.lang.String |
NAME
Constant with the field name 98H
|
static java.lang.Integer |
NUMBER
Component number for the Number subfield
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
TIME
Component number for the Time subfield
|
static java.lang.Integer |
TIME_2
Component number for the Time 2 subfield
|
components
Constructor and Description |
---|
Field98H()
Default constructor.
|
Field98H(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field98H(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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field98H |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field98H object.
|
static Field98H |
get(SwiftMessage msg)
Gets the first instance of Field98H in the given message.
|
static Field98H |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field98H> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field98H in the given message
an empty list is returned if none found.
|
static java.util.List<Field98H> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field98H from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component1
|
java.util.Calendar |
getComponent1AsCalendar()
Get the component1 as Calendar
|
java.lang.String |
getComponent2()
Gets the component2
|
java.lang.Number |
getComponent2AsNumber()
Get the component2 as Number
|
java.lang.String |
getComponent3()
Gets the component3
|
java.util.Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
java.lang.String |
getComponent4()
Gets the component4
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getN()
Gets the N (component3).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.util.Currency |
getNAsCurrency()
Get the N (component3) as Currency
|
java.lang.String |
getNumber()
Gets the Number (component2).
|
java.lang.Number |
getNumberAsNumber()
Get the Number (component2) as Number
|
java.lang.String |
getTime()
Gets the Time (component1).
|
java.lang.String |
getTime2()
Gets the Time 2 (component4).
|
java.util.Calendar |
getTime2AsCalendar()
Get the Time 2 (component4) as Calendar
|
java.util.Calendar |
getTimeAsCalendar()
Get the Time (component1) 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 |
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 Field98H |
newInstance(Field98H 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() |
Field98H |
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.
|
Field98H |
setComponent1(java.lang.String component1)
Set the component1.
|
Field98H |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field98H |
setComponent2(java.lang.String component2)
Set the component2.
|
Field98H |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field98H |
setComponent3(java.lang.String component3)
Set the component3.
|
Field98H |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field98H |
setComponent4(java.lang.String component4)
Set the component4.
|
Field98H |
setN(java.util.Currency component3)
Set the N (component3) from a Currency object.
|
Field98H |
setN(java.lang.String component3)
Set the N (component3).
|
Field98H |
setNumber(java.lang.Number component2)
Set the Number (component2) from a Number object.
|
Field98H |
setNumber(java.lang.String component2)
Set the Number (component2).
|
Field98H |
setTime(java.util.Calendar component1)
Set the Time (component1) from a Calendar object.
|
Field98H |
setTime(java.lang.String component1)
Set the Time (component1).
|
Field98H |
setTime2(java.util.Calendar component4)
Set the Time 2 (component4) from a Calendar object.
|
Field98H |
setTime2(java.lang.String component4)
Set the Time 2 (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, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_98H
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer TIME
public static final java.lang.Integer NUMBER
public static final java.lang.Integer N
public static final java.lang.Integer TIME_2
public Field98H()
public Field98H(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field98H(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 Field98H newInstance(Field98H 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()
public java.util.Calendar getComponent1AsCalendar()
public java.lang.String getTime()
public java.util.Calendar getTimeAsCalendar()
public Field98H setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field98H setComponent1(java.util.Calendar component1)
component1
- the Calendar with the component1 content to setpublic Field98H setTime(java.lang.String component1)
component1
- the Time to setpublic Field98H setTime(java.util.Calendar component1)
component1
- Calendar with the Time content to setsetComponent1(java.util.Calendar)
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getNumber()
public java.lang.Number getNumberAsNumber()
public Field98H setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field98H setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field98H setNumber(java.lang.String component2)
component2
- the Number to setpublic Field98H setNumber(java.lang.Number component2)
component2
- Number with the Number content to setsetComponent2(java.lang.Number)
public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getN()
public java.util.Currency getNAsCurrency()
public Field98H setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field98H setComponent3(java.util.Currency component3)
component3
- the Currency with the component3 content to setpublic Field98H setN(java.lang.String component3)
component3
- the N to setpublic Field98H setN(java.util.Currency component3)
component3
- Currency with the N content to setsetComponent3(java.util.Currency)
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getTime2()
public java.util.Calendar getTime2AsCalendar()
public Field98H setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field98H setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field98H setTime2(java.lang.String component4)
component4
- the Time 2 to setpublic Field98H setTime2(java.util.Calendar component4)
component4
- Calendar with the Time 2 content to setsetComponent4(java.util.Calendar)
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 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 Field98H get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field98H get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field98H> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field98H> 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)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public static Field98H fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)