@Generated public class Field344 extends Field implements java.io.Serializable
Model and parser for field 344 of a SWIFT MT message.
Subfields (components) Data types
Character
Long
Structure definition
1!a[9n]
c[N]
cN
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_344
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
MESSAGE_CATEGORIES
Component number for the Message Categories subfield.
|
static java.lang.String |
NAME
Constant with the field name 344.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PRIORITY
Component number for the Priority 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 |
---|
Field344()
Default constructor.
|
Field344(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field344(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 Field344 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field344 object.
|
static Field344 |
get(SwiftMessage msg)
Gets the first instance of Field344 in the given message.
|
static Field344 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field344> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field344 in the given message
an empty list is returned if none found.
|
static java.util.List<Field344> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field344 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Priority).
|
java.lang.String |
getComponent2()
Gets the component 2 (Message Categories).
|
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 |
getMessageCategories()
Gets the Message Categories (component 2).
|
java.lang.Long |
getMessageCategoriesAsLong()
Get the Message Categories (component 2) as Long
|
java.lang.Number |
getMessageCategoriesAsNumber()
Deprecated.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getPriority()
Gets the Priority (component 1).
|
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 Field344 |
newInstance(Field344 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.
|
Field344 |
setComponent1(java.lang.String component1)
Set the component 1 (Priority).
|
Field344 |
setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
|
Field344 |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Message Categories (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field344 |
setComponent2(java.lang.String component2)
Set the component 2 (Message Categories).
|
Field344 |
setMessageCategories(java.lang.Long component2)
Set the Message Categories (component 2) from a Long object.
|
Field344 |
setMessageCategories(java.lang.Number component2)
Alternative method setter for field's Message Categories (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field344 |
setMessageCategories(java.lang.String component2)
Set the Message Categories (component 2).
|
Field344 |
setPriority(java.lang.String component1)
Set the Priority (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_344
@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 PRIORITY
public static final java.lang.Integer MESSAGE_CATEGORIES
public Field344()
public Field344(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field344(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field344 newInstance(Field344 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.String getPriority()
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 getMessageCategories()
public java.lang.Long getMessageCategoriesAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getMessageCategoriesAsNumber()
getComponent2AsLong()
to get the proper value.getMessageCategoriesAsLong()
public Field344 setComponent1(java.lang.String component1)
component1
- the Priority to setpublic Field344 setPriority(java.lang.String component1)
component1
- the Priority to setpublic Field344 setComponent2(java.lang.String component2)
component2
- the Message Categories to setpublic Field344 setComponent2(java.lang.Long component2)
component2
- the Long with the Message Categories content to setsetComponent2(String)
public Field344 setComponent2(java.lang.Number component2)
component2
- the Number with the Message Categories content to setsetMessageCategories(java.lang.Long)
public Field344 setMessageCategories(java.lang.String component2)
component2
- the Message Categories to setpublic Field344 setMessageCategories(java.lang.Long component2)
component2
- Long with the Message Categories content to setsetComponent2(java.lang.Long)
public Field344 setMessageCategories(java.lang.Number component2)
component2
- the Number with the Message Categories content to setsetMessageCategories(java.lang.Long)
public java.lang.String getName()
public static Field344 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field344 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field344> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field344> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field344 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)