@Generated public class Field28D extends Field implements java.io.Serializable
Model and parser for field 28D of a SWIFT MT message.
Subfields (components) Data types
Long
Long
Structure definition
5n/5n
S/S
NN
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.String |
F_28D
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
MESSAGE_INDEX
Component number for the Message Index subfield.
|
static java.lang.String |
NAME
Constant with the field name 28D.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
SEQUENCE_NUMBER
Deprecated.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
STATEMENT_NUMBER
Deprecated.
|
static java.lang.Integer |
TOTAL
Component number for the Total subfield.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field28D()
Default constructor.
|
Field28D(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field28D(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 Field28D |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field28D object.
|
static Field28D |
get(SwiftMessage msg)
Gets the first instance of Field28D in the given message.
|
static Field28D |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field28D> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field28D in the given message
an empty list is returned if none found.
|
static java.util.List<Field28D> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field28D from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Message Index).
|
java.lang.Long |
getComponent1AsLong()
Get the component 1 as Long
|
java.lang.Number |
getComponent1AsNumber()
Deprecated.
|
java.lang.String |
getComponent2()
Gets the component 2 (Total).
|
java.lang.Long |
getComponent2AsLong()
Get the component 2 as Long
|
java.lang.Number |
getComponent2AsNumber()
Deprecated.
|
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 |
getMessageIndex()
Gets the Message Index (component 1).
|
java.lang.Long |
getMessageIndexAsLong()
Get the Message Index (component 1) as Long
|
java.lang.Number |
getMessageIndexAsNumber()
Deprecated.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getSequenceNumber()
Deprecated.
|
java.lang.Long |
getSequenceNumberAsLong()
Deprecated.
|
java.lang.Number |
getSequenceNumberAsNumber()
Deprecated.
|
java.lang.String |
getStatementNumber()
Deprecated.
|
java.lang.Long |
getStatementNumberAsLong()
Deprecated.
|
java.lang.Number |
getStatementNumberAsNumber()
Deprecated.
|
java.lang.String |
getTotal()
Gets the Total (component 2).
|
java.lang.Long |
getTotalAsLong()
Get the Total (component 2) as Long
|
java.lang.Number |
getTotalAsNumber()
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 Field28D |
newInstance(Field28D 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.
|
Field28D |
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
|
Field28D |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Message Index (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field28D |
setComponent1(java.lang.String component1)
Set the component 1 (Message Index).
|
Field28D |
setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
|
Field28D |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Total (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field28D |
setComponent2(java.lang.String component2)
Set the component 2 (Total).
|
Field28D |
setMessageIndex(java.lang.Long component1)
Set the Message Index (component 1) from a Long object.
|
Field28D |
setMessageIndex(java.lang.Number component1)
Alternative method setter for field's Message Index (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field28D |
setMessageIndex(java.lang.String component1)
Set the Message Index (component 1).
|
Field28D |
setSequenceNumber(java.lang.Long component2)
Deprecated.
|
Field28D |
setSequenceNumber(java.lang.Number component2)
Deprecated.
|
Field28D |
setSequenceNumber(java.lang.String component2)
Deprecated.
|
Field28D |
setStatementNumber(java.lang.Long component1)
Deprecated.
|
Field28D |
setStatementNumber(java.lang.Number component1)
Deprecated.
|
Field28D |
setStatementNumber(java.lang.String component1)
Deprecated.
|
Field28D |
setTotal(java.lang.Long component2)
Set the Total (component 2) from a Long object.
|
Field28D |
setTotal(java.lang.Number component2)
Alternative method setter for field's Total (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field28D |
setTotal(java.lang.String component2)
Set the Total (component 2).
|
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_28D
@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 MESSAGE_INDEX
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer STATEMENT_NUMBER
MESSAGE_INDEX
public static final java.lang.Integer TOTAL
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer SEQUENCE_NUMBER
TOTAL
public Field28D()
public Field28D(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field28D(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field28D newInstance(Field28D 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.lang.Long getComponent1AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent1AsNumber()
getComponent1AsLong()
to get the proper value.getComponent1AsLong()
public java.lang.String getMessageIndex()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getStatementNumber()
getMessageIndex()
public java.lang.Long getMessageIndexAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getMessageIndexAsNumber()
getComponent1AsLong()
to get the proper value.getMessageIndexAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Long getStatementNumberAsLong()
getMessageIndexAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getStatementNumberAsNumber()
getComponent1AsLong()
to get the proper value.getMessageIndexAsLong()
public java.lang.String getComponent2()
public java.lang.Long getComponent2AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent2AsNumber()
getComponent2AsLong()
to get the proper value.getComponent2AsLong()
public java.lang.String getTotal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getSequenceNumber()
getTotal()
public java.lang.Long getTotalAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getTotalAsNumber()
getComponent2AsLong()
to get the proper value.getTotalAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Long getSequenceNumberAsLong()
getTotalAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getSequenceNumberAsNumber()
getComponent2AsLong()
to get the proper value.getTotalAsLong()
public Field28D setComponent1(java.lang.String component1)
component1
- the Message Index to setpublic Field28D setComponent1(java.lang.Long component1)
component1
- the Long with the Message Index content to setsetComponent1(String)
public Field28D setComponent1(java.lang.Number component1)
component1
- the Number with the Message Index content to setsetMessageIndex(java.lang.Long)
public Field28D setMessageIndex(java.lang.String component1)
component1
- the Message Index to setpublic Field28D setMessageIndex(java.lang.Long component1)
component1
- Long with the Message Index content to setsetComponent1(java.lang.Long)
public Field28D setMessageIndex(java.lang.Number component1)
component1
- the Number with the Message Index content to setsetMessageIndex(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setStatementNumber(java.lang.String component1)
component1
- the Message Index to setsetMessageIndex(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setStatementNumber(java.lang.Long component1)
component1
- Long with the Message Index content to setsetComponent1(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setStatementNumber(java.lang.Number component1)
component1
- the Number with the Message Index content to setsetMessageIndex(java.lang.Long)
public Field28D setComponent2(java.lang.String component2)
component2
- the Total to setpublic Field28D setComponent2(java.lang.Long component2)
component2
- the Long with the Total content to setsetComponent2(String)
public Field28D setComponent2(java.lang.Number component2)
component2
- the Number with the Total content to setsetTotal(java.lang.Long)
public Field28D setTotal(java.lang.String component2)
component2
- the Total to setpublic Field28D setTotal(java.lang.Long component2)
component2
- Long with the Total content to setsetComponent2(java.lang.Long)
public Field28D setTotal(java.lang.Number component2)
component2
- the Number with the Total content to setsetTotal(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setSequenceNumber(java.lang.String component2)
component2
- the Total to setsetTotal(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setSequenceNumber(java.lang.Long component2)
component2
- Long with the Total content to setsetComponent2(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field28D setSequenceNumber(java.lang.Number component2)
component2
- the Number with the Total content to setsetTotal(java.lang.Long)
public java.lang.String getName()
public static Field28D get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field28D get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field28D> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field28D> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field28D fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)