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