Class Field344
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field344
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field344 extends Field implements java.io.Serializable
SWIFT MT Field 344.Model and parser for field 344 of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Priority:
Character
- Component 2: MessageCategories:
Long
Structure definition
- validation pattern:
1!a[9n]
- parser pattern:
c[N]
- components pattern:
cN
This class complies with standard release SRU2022
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
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.UseparserPattern()
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.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field344()
Default constructor.Field344(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field344(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
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 Longjava.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
getMessageCategories()
Gets the Message Categories (component 2).java.lang.Long
getMessageCategoriesAsLong()
Get the Message Categories (component 2) as Longjava.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-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
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
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 344.- See Also:
- Constant Field Values
-
F_344
public static final java.lang.String F_344
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
PRIORITY
public static final java.lang.Integer PRIORITY
Component number for the Priority subfield.
-
MESSAGE_CATEGORIES
public static final java.lang.Integer MESSAGE_CATEGORIES
Component number for the Message Categories subfield.
-
-
Constructor Detail
-
Field344
public Field344()
Default constructor. Creates a new field setting all components to null.
-
Field344
public Field344(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field344
public Field344(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field344 newInstance(Field344 source)
Copy constructor. Initializes the components list with a deep copy of the source components list.- Parameters:
source
- a field instance to copy- Since:
- 7.7
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew Tag(NAME, value)
- Since:
- 7.5
- See Also:
NAME
-
emptyTag
public static Tag emptyTag()
Create a Tag with this field name and an empty string as value. Shorthand fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
isOptional
public 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.- Specified by:
isOptional
in classField
- Parameters:
component
- component number, first component of a field is referenced as 1- Returns:
- true if the component is optional for this field, false otherwise
-
isGeneric
public boolean isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
-
componentsSize
public 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.- Specified by:
componentsSize
in classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Priority).- Returns:
- the component 1
-
getPriority
public java.lang.String getPriority()
Gets the Priority (component 1).- Returns:
- the Priority from component 1
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Message Categories).- Returns:
- the component 2
-
getComponent2AsLong
public java.lang.Long getComponent2AsLong()
Get the component 2 as Long- Returns:
- the component 2 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent2AsNumber
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent2AsNumber()
Deprecated.Get the component 2 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should usegetComponent2AsLong()
to get the proper value.- Returns:
- the component 2 converted to Number (BigDecimal) or null if cannot be converted
- See Also:
getComponent2AsLong()
-
getMessageCategories
public java.lang.String getMessageCategories()
Gets the Message Categories (component 2).- Returns:
- the Message Categories from component 2
-
getMessageCategoriesAsLong
public java.lang.Long getMessageCategoriesAsLong()
Get the Message Categories (component 2) as Long- Returns:
- the Message Categories from component 2 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getMessageCategoriesAsNumber
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getMessageCategoriesAsNumber()
Deprecated.Get the Message Categories (component 2) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should usegetComponent2AsLong()
to get the proper value.- Returns:
- the component 2 converted to Number (BigDecimal) or null if cannot be converted
- See Also:
getMessageCategoriesAsLong()
-
setComponent1
public Field344 setComponent1(java.lang.String component1)
Set the component 1 (Priority).- Parameters:
component1
- the Priority to set- Returns:
- the field object to enable build pattern
-
setPriority
public Field344 setPriority(java.lang.String component1)
Set the Priority (component 1).- Parameters:
component1
- the Priority to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field344 setComponent2(java.lang.String component2)
Set the component 2 (Message Categories).- Parameters:
component2
- the Message Categories to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field344 setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.- Parameters:
component2
- the Long with the Message Categories content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent2(String)
-
setComponent2
public 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)- Parameters:
component2
- the Number with the Message Categories content to set- Returns:
- the field object to enable build pattern
- See Also:
setMessageCategories(java.lang.Long)
-
setMessageCategories
public Field344 setMessageCategories(java.lang.String component2)
Set the Message Categories (component 2).- Parameters:
component2
- the Message Categories to set- Returns:
- the field object to enable build pattern
-
setMessageCategories
public Field344 setMessageCategories(java.lang.Long component2)
Set the Message Categories (component 2) from a Long object.- Parameters:
component2
- Long with the Message Categories content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent2(java.lang.Long)
-
setMessageCategories
public 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)- Parameters:
component2
- the Number with the Message Categories content to set- Returns:
- the field object to enable build pattern
- See Also:
setMessageCategories(java.lang.Long)
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field344 get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.- Parameters:
block
- may be null or empty- Returns:
- null if not found o block is null or empty
-
get
public static Field344 get(SwiftMessage msg)
Gets the first instance of Field344 in the given message.- Parameters:
msg
- may be empty or null- Returns:
- null if not found or msg is empty or null
- See Also:
get(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
msg
- may be empty or null in which case an empty list is returned- See Also:
getAll(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
block
- may be empty or null in which case an empty list is returned
-
fromJson
public static Field344 fromJson(java.lang.String json)
This method deserializes the JSON data into a Field344 object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
-