@Generated public class Field64 extends Field implements java.io.Serializable, DateContainer, AmountContainer
Model and parser for field 64 of a SWIFT MT message.
Subfields (components) Data types
String
Calendar
String
Number
Structure definition
<DC><DATE2><3!a><AMOUNT>15
[c]<DATE2>SN
SESN
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield
|
static java.lang.Integer |
DATE
Component number for the Date subfield
|
static java.lang.Integer |
DC_MARK
Component number for the D/C Mark subfield
|
static java.lang.String |
F_64
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 64
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field64()
Default constructor.
|
Field64(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field64(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()
Get the first amount in this field.
|
java.util.List<java.math.BigDecimal> |
amounts() |
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. |
java.util.List<java.util.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 Field64 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field64 object.
|
static Field64 |
get(SwiftMessage msg)
Gets the first instance of Field64 in the given message.
|
static Field64 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field64> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field64 in the given message
an empty list is returned if none found.
|
static java.util.List<Field64> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field64 from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component4).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component4) as Number
|
java.lang.String |
getComponent1()
Gets the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component3
|
java.util.Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
java.lang.String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent4()
Gets the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 as Number
|
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 |
getCurrency()
Gets the Currency (component3).
|
java.lang.String |
getDate()
Gets the Date (component2).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
java.lang.String |
getDCMark()
Gets the D/C Mark (component1).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
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 Field64 |
newInstance(Field64 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() |
Field64 |
setAmount(java.lang.Number component4)
Set the Amount (component4) from a Number object.
|
Field64 |
setAmount(java.lang.String component4)
Set the Amount (component4).
|
Field64 |
setComponent1(java.lang.String component1)
Set the component1.
|
Field64 |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field64 |
setComponent2(java.lang.String component2)
Set the component2.
|
Field64 |
setComponent3(java.lang.String component3)
Set the component3.
|
Field64 |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field64 |
setComponent4(java.lang.String component4)
Set the component4.
|
Field64 |
setCurrency(java.lang.String component3)
Set the Currency (component3).
|
Field64 |
setDate(java.util.Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field64 |
setDate(java.lang.String component2)
Set the Date (component2).
|
Field64 |
setDCMark(java.lang.String component1)
Set the D/C Mark (component1).
|
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_64
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DC_MARK
public static final java.lang.Integer DATE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public Field64()
public Field64(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field64(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 Field64 newInstance(Field64 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()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getDCMark()
public Field64 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field64 setDCMark(java.lang.String component1)
component1
- the D/C Mark to setpublic java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public Field64 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field64 setComponent2(java.util.Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field64 setDate(java.lang.String component2)
component2
- the Date to setpublic Field64 setDate(java.util.Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent3AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCurrency()
public Field64 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field64 setCurrency(java.lang.String component3)
component3
- the Currency to setpublic java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
public Field64 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field64 setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setpublic Field64 setAmount(java.lang.String component4)
component4
- the Amount to setpublic Field64 setAmount(java.lang.Number component4)
component4
- Number with the Amount content to setsetComponent4(java.lang.Number)
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
AmountResolver.amount(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 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 Field64 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field64 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field64> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field64> 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 Field64 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)
public java.util.Currency getComponent3AsCurrency()