@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
Long
String
Calendar
Structure definition
<TIME2>[,3n][/[<N>]<TIME3>]
<TIME2>[,S][/[c]<TIME3>]
TNSW
This class complies with standard release SRU2023
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
DECIMALS
Component number for the Decimals subfield.
|
static java.lang.String |
F_98H
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 98H.
|
static java.lang.Integer |
NUMBER
Deprecated.
use #DECIMALS instead
|
static java.lang.Integer |
OFFSET
Component number for the Offset subfield.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
SIGN
Component number for the Sign 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.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components, labelMap
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()
Deprecated.
Use
typesPattern() instead. |
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.
|
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 component 1 (Time).
|
java.util.Calendar |
getComponent1AsCalendar()
Get the component 1 as Calendar
|
java.lang.String |
getComponent2()
Gets the component 2 (Decimals).
|
java.lang.Long |
getComponent2AsLong()
Get the component 2 as Long
|
java.lang.Number |
getComponent2AsNumber()
Deprecated.
use #getComponent2AsLong() instead
|
java.lang.String |
getComponent3()
Gets the component 3 (Sign).
|
java.lang.String |
getComponent4()
Gets the component 4 (Offset).
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component 4 as Calendar
|
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 |
getDecimals()
Gets the Decimals (component 2).
|
java.lang.Long |
getDecimalsAsLong()
Get the Decimals (component 2) as Long
|
java.lang.Number |
getDecimalsAsNumber()
Deprecated.
use #getDecimalsAsLong() instead
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getNumber()
Deprecated.
use #getDecimals() instead
|
java.lang.Long |
getNumberAsLong()
Deprecated.
use #getDecimalsAsLong() instead
|
java.lang.Number |
getNumberAsNumber()
Deprecated.
use #getDecimalsAsLong() instead
|
java.lang.String |
getOffset()
Gets the Offset (component 4).
|
java.util.Calendar |
getOffsetAsCalendar()
Get the Offset (component 4) as Calendar
|
java.lang.String |
getSign()
Gets the Sign (component 3).
|
java.lang.String |
getTime()
Gets the Time (component 1).
|
java.util.Calendar |
getTimeAsCalendar()
Get the Time (component 1) as Calendar
|
java.lang.String |
getUtcIndicator()
Get the ISO UTC Indicator combining the sign and offset, and changing the "N" negative sign indication by
proper +/- signs
|
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.
|
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern.
|
Field98H |
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.
|
Field98H |
setComponent1(java.lang.String component1)
Set the component 1 (Time).
|
Field98H |
setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
|
Field98H |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Decimals (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field98H |
setComponent2(java.lang.String component2)
Set the component 2 (Decimals).
|
Field98H |
setComponent3(java.lang.String component3)
Set the component 3 (Sign).
|
Field98H |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field98H |
setComponent4(java.lang.String component4)
Set the component 4 (Offset).
|
Field98H |
setDecimals(java.lang.Long component2)
Set the Decimals (component 2) from a Long object.
|
Field98H |
setDecimals(java.lang.Number component2)
Alternative method setter for field's Decimals (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field98H |
setDecimals(java.lang.String component2)
Set the Decimals (component 2).
|
Field98H |
setNumber(java.lang.Long component2)
Deprecated.
use #setComponent2(java.lang.Long) instead
|
Field98H |
setNumber(java.lang.Number component2)
Deprecated.
use #setDecimals(java.lang.Long) instead
|
Field98H |
setNumber(java.lang.String component2)
Deprecated.
use #setDecimals(String) instead
|
Field98H |
setOffset(java.util.Calendar component4)
Set the Offset (component 4) from a Calendar object.
|
Field98H |
setOffset(java.lang.String component4)
Set the Offset (component 4).
|
Field98H |
setSign(java.lang.String component3)
Set the Sign (component 3).
|
Field98H |
setTime(java.util.Calendar component1)
Set the Time (component 1) from a Calendar object.
|
Field98H |
setTime(java.lang.String component1)
Set the Time (component 1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Returns the field component types pattern.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, 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
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer TIME
public static final java.lang.Integer DECIMALS
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer NUMBER
public static final java.lang.Integer SIGN
public static final java.lang.Integer OFFSET
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 static Field98H newInstance(Field98H source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
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 field@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
public 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.util.Calendar getComponent1AsCalendar()
public java.lang.String getTime()
public java.util.Calendar getTimeAsCalendar()
public java.lang.String getComponent2()
public java.lang.Long getComponent2AsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent2AsNumber()
public java.lang.String getDecimals()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getNumber()
public java.lang.Long getDecimalsAsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getDecimalsAsNumber()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Long getNumberAsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberAsNumber()
public java.lang.String getComponent3()
public java.lang.String getSign()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getOffset()
public java.util.Calendar getOffsetAsCalendar()
public Field98H setComponent1(java.lang.String component1)
component1
- the Time to setpublic Field98H setComponent1(java.util.Calendar component1)
component1
- the Calendar with the Time 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 Field98H setComponent2(java.lang.String component2)
component2
- the Decimals to setpublic Field98H setComponent2(java.lang.Long component2)
component2
- the Long with the Decimals content to setsetComponent2(String)
public Field98H setComponent2(java.lang.Number component2)
component2
- the Number with the Decimals content to setsetDecimals(java.lang.Long)
public Field98H setDecimals(java.lang.String component2)
component2
- the Decimals to setpublic Field98H setDecimals(java.lang.Long component2)
component2
- Long with the Decimals content to setsetComponent2(java.lang.Long)
public Field98H setDecimals(java.lang.Number component2)
component2
- the Number with the Decimals content to setsetDecimals(java.lang.Long)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field98H setNumber(java.lang.String component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field98H setNumber(java.lang.Long component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field98H setNumber(java.lang.Number component2)
public Field98H setComponent3(java.lang.String component3)
component3
- the Sign to setpublic Field98H setSign(java.lang.String component3)
component3
- the Sign to setpublic Field98H setComponent4(java.lang.String component4)
component4
- the Offset to setpublic Field98H setComponent4(java.util.Calendar component4)
component4
- the Calendar with the Offset content to setpublic Field98H setOffset(java.lang.String component4)
component4
- the Offset to setpublic Field98H setOffset(java.util.Calendar component4)
component4
- Calendar with the Offset content to setsetComponent4(java.util.Calendar)
public java.lang.String getName()
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 static Field98H fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)
public java.lang.String getUtcIndicator()