@Generated public class Field37E extends Field implements java.io.Serializable, AmountContainer, DateContainer
Model and parser for field 37E of a SWIFT MT message.
Subfields (components) Data types
BigDecimal
Calendar
String
Long
String
Structure definition
<AMOUNT>12[//<DATE2><DM>3n][/16x]
N[//<DATE2>cS][/S]
NESNS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
DATE
Deprecated.
|
static java.lang.Integer |
DM_MARK
Deprecated.
|
static java.lang.Integer |
END_DATE
Component number for the End Date subfield.
|
static java.lang.String |
F_37E
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
INFORMATION
Component number for the Information subfield.
|
static java.lang.String |
NAME
Constant with the field name 37E.
|
static java.lang.Integer |
NUMBER
Component number for the Number subfield.
|
static java.lang.Integer |
NUMBER_OF_DAYSMONTHS
Deprecated.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PERIOD
Component number for the Period subfield.
|
static java.lang.Integer |
RATE
Component number for the Rate subfield.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field37E()
Default constructor.
|
Field37E(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field37E(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
amount()
Returns the first amounts as BigDecimal
|
java.util.List<java.math.BigDecimal> |
amounts()
Returns the list of all NON-NULL amounts as BigDecimal
|
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. |
java.util.Calendar |
date()
Returns the first component that can be converted to a Calendar
|
java.util.List<java.util.Calendar> |
dates()
Returns all components that can be converted to a Calendar
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field37E |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field37E object.
|
static Field37E |
get(SwiftMessage msg)
Gets the first instance of Field37E in the given message.
|
static Field37E |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field37E> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field37E in the given message
an empty list is returned if none found.
|
static java.util.List<Field37E> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field37E from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Rate).
|
java.math.BigDecimal |
getComponent1AsBigDecimal()
Get the component 1 as BigDecimal
|
java.lang.Number |
getComponent1AsNumber()
Deprecated.
|
java.lang.String |
getComponent2()
Gets the component 2 (End Date).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Period).
|
java.lang.String |
getComponent4()
Gets the component 4 (Number).
|
java.lang.Long |
getComponent4AsLong()
Get the component 4 as Long
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
java.lang.String |
getComponent5()
Gets the component 5 (Information).
|
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 |
getDate()
Deprecated.
|
java.util.Calendar |
getDateAsCalendar()
Deprecated.
|
java.lang.String |
getDMMark()
Deprecated.
|
java.lang.String |
getEndDate()
Gets the End Date (component 2).
|
java.util.Calendar |
getEndDateAsCalendar()
Get the End Date (component 2) as Calendar
|
java.lang.String |
getInformation()
Gets the Information (component 5).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getNumber()
Gets the Number (component 4).
|
java.lang.Long |
getNumberAsLong()
Get the Number (component 4) as Long
|
java.lang.Number |
getNumberAsNumber()
Deprecated.
|
java.lang.String |
getNumberofDaysMonths()
Deprecated.
|
java.lang.Long |
getNumberofDaysMonthsAsLong()
Deprecated.
|
java.lang.Number |
getNumberofDaysMonthsAsNumber()
Deprecated.
|
java.lang.String |
getPeriod()
Gets the Period (component 3).
|
java.lang.String |
getRate()
Gets the Rate (component 1).
|
java.math.BigDecimal |
getRateAsBigDecimal()
Get the Rate (component 1) as BigDecimal
|
java.lang.Number |
getRateAsNumber()
Deprecated.
|
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 Field37E |
newInstance(Field37E 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.
|
Field37E |
setComponent1(java.math.BigDecimal component1)
Set the component1 from a BigDecimal object.
|
Field37E |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Rate (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field37E |
setComponent1(java.lang.String component1)
Set the component 1 (Rate).
|
Field37E |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field37E |
setComponent2(java.lang.String component2)
Set the component 2 (End Date).
|
Field37E |
setComponent3(java.lang.String component3)
Set the component 3 (Period).
|
Field37E |
setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
|
Field37E |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Number (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field37E |
setComponent4(java.lang.String component4)
Set the component 4 (Number).
|
Field37E |
setComponent5(java.lang.String component5)
Set the component 5 (Information).
|
Field37E |
setDate(java.util.Calendar component2)
Deprecated.
|
Field37E |
setDate(java.lang.String component2)
Deprecated.
|
Field37E |
setDMMark(java.lang.String component3)
Deprecated.
|
Field37E |
setEndDate(java.util.Calendar component2)
Set the End Date (component 2) from a Calendar object.
|
Field37E |
setEndDate(java.lang.String component2)
Set the End Date (component 2).
|
Field37E |
setInformation(java.lang.String component5)
Set the Information (component 5).
|
Field37E |
setNumber(java.lang.Long component4)
Set the Number (component 4) from a Long object.
|
Field37E |
setNumber(java.lang.Number component4)
Alternative method setter for field's Number (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field37E |
setNumber(java.lang.String component4)
Set the Number (component 4).
|
Field37E |
setNumberofDaysMonths(java.lang.Long component4)
Deprecated.
|
Field37E |
setNumberofDaysMonths(java.lang.Number component4)
Deprecated.
|
Field37E |
setNumberofDaysMonths(java.lang.String component4)
Deprecated.
|
Field37E |
setPeriod(java.lang.String component3)
Set the Period (component 3).
|
Field37E |
setRate(java.math.BigDecimal component1)
Set the Rate (component 1) from a BigDecimal object.
|
Field37E |
setRate(java.lang.Number component1)
Alternative method setter for field's Rate (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field37E |
setRate(java.lang.String component1)
Set the Rate (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, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, 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_37E
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer RATE
public static final java.lang.Integer END_DATE
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer DATE
END_DATE
public static final java.lang.Integer PERIOD
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer DM_MARK
PERIOD
public static final java.lang.Integer NUMBER
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer NUMBER_OF_DAYSMONTHS
NUMBER
public static final java.lang.Integer INFORMATION
public Field37E()
public Field37E(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field37E(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field37E newInstance(Field37E 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(phase3=SRU2023) 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
public java.lang.String getComponent1()
public java.math.BigDecimal getComponent1AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent1AsNumber()
getComponent1AsBigDecimal()
to get the proper value.getComponent1AsBigDecimal()
public java.lang.String getRate()
public java.math.BigDecimal getRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getRateAsNumber()
getComponent1AsBigDecimal()
to get the proper value.getRateAsBigDecimal()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getEndDate()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getDate()
getEndDate()
public java.util.Calendar getEndDateAsCalendar()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.util.Calendar getDateAsCalendar()
getEndDateAsCalendar()
public java.lang.String getComponent3()
public java.lang.String getPeriod()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getDMMark()
getPeriod()
public java.lang.String getComponent4()
public java.lang.Long getComponent4AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent4AsNumber()
getComponent4AsLong()
to get the proper value.getComponent4AsLong()
public java.lang.String getNumber()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getNumberofDaysMonths()
getNumber()
public java.lang.Long getNumberAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumberAsNumber()
getComponent4AsLong()
to get the proper value.getNumberAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Long getNumberofDaysMonthsAsLong()
getNumberAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumberofDaysMonthsAsNumber()
getComponent4AsLong()
to get the proper value.getNumberAsLong()
public java.lang.String getComponent5()
public java.lang.String getInformation()
public Field37E setComponent1(java.lang.String component1)
component1
- the Rate to setpublic Field37E setComponent1(java.math.BigDecimal component1)
component1
- the BigDecimal with the Rate content to setpublic Field37E setComponent1(java.lang.Number component1)
component1
- the Number with the Rate content to setsetRate(java.math.BigDecimal)
public Field37E setRate(java.lang.String component1)
component1
- the Rate to setpublic Field37E setRate(java.math.BigDecimal component1)
component1
- BigDecimal with the Rate content to setsetComponent1(java.math.BigDecimal)
public Field37E setRate(java.lang.Number component1)
component1
- the Number with the Rate content to setsetRate(java.math.BigDecimal)
public Field37E setComponent2(java.lang.String component2)
component2
- the End Date to setpublic Field37E setComponent2(java.util.Calendar component2)
component2
- the Calendar with the End Date content to setpublic Field37E setEndDate(java.lang.String component2)
component2
- the End Date to setpublic Field37E setEndDate(java.util.Calendar component2)
component2
- Calendar with the End Date content to setsetComponent2(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setDate(java.lang.String component2)
component2
- the End Date to setsetEndDate(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setDate(java.util.Calendar component2)
component2
- Calendar with the End Date content to setsetComponent2(java.util.Calendar)
public Field37E setComponent3(java.lang.String component3)
component3
- the Period to setpublic Field37E setPeriod(java.lang.String component3)
component3
- the Period to set@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setDMMark(java.lang.String component3)
component3
- the Period to setsetPeriod(String)
public Field37E setComponent4(java.lang.String component4)
component4
- the Number to setpublic Field37E setComponent4(java.lang.Long component4)
component4
- the Long with the Number content to setsetComponent4(String)
public Field37E setComponent4(java.lang.Number component4)
component4
- the Number with the Number content to setsetNumber(java.lang.Long)
public Field37E setNumber(java.lang.String component4)
component4
- the Number to setpublic Field37E setNumber(java.lang.Long component4)
component4
- Long with the Number content to setsetComponent4(java.lang.Long)
public Field37E setNumber(java.lang.Number component4)
component4
- the Number with the Number content to setsetNumber(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setNumberofDaysMonths(java.lang.String component4)
component4
- the Number to setsetNumber(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setNumberofDaysMonths(java.lang.Long component4)
component4
- Long with the Number content to setsetComponent4(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field37E setNumberofDaysMonths(java.lang.Number component4)
component4
- the Number with the Number content to setsetNumber(java.lang.Long)
public Field37E setComponent5(java.lang.String component5)
component5
- the Information to setpublic Field37E setInformation(java.lang.String component5)
component5
- the Information to setpublic java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
amount
in interface AmountContainer
AmountResolver.amount(Field)
public java.util.List<java.util.Calendar> dates()
dates
in interface DateContainer
public java.util.Calendar date()
public java.lang.String getName()
public static Field37E get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field37E get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field37E> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field37E> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field37E fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)