Class Field23E
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field23E
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field23E extends Field implements java.io.Serializable
SWIFT MT Field 23E.Model and parser for field 23E of a SWIFT MT message.
Subfields (components) Data types
- Component 1: InstructionCode:
String
- Component 2: AdditionalInformation:
String
Structure definition
- validation pattern:
4!c[/30x]
- parser pattern:
S[/S]
- components pattern:
SS
This class complies with standard release SRU2022
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
ADDITIONAL_INFORMATION
Component number for the Additional Information subfield.static java.lang.Integer
CODE
Deprecated.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.String
F_23E
Same as NAME, intended to be clear when using static imports.static java.lang.Integer
INSTRUCTION_CODE
Component number for the Instruction Code subfield.static java.lang.String
NAME
Constant with the field name 23E.static java.lang.Integer
NARRATIVE
Alternative constant name for field's Additional Information Component number.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.Integer
TYPE
Alternative constant name for field's Instruction Code Component number.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 Field23E()
Default constructor.Field23E(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field23E(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 Field23E
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field23E object.static Field23E
get(SwiftMessage msg)
Gets the first instance of Field23E in the given message.static Field23E
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.java.lang.String
getAdditionalInformation()
Gets the Additional Information (component 2).static java.util.List<Field23E>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field23E in the given message an empty list is returned if none found.static java.util.List<Field23E>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field23E from the given block an empty list is returned if none found.java.lang.String
getCode()
Deprecated.java.lang.String
getComponent1()
Gets the component 1 (Instruction Code).java.lang.String
getComponent2()
Gets the component 2 (Additional Information).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
getInstructionCode()
Gets the Instruction Code (component 1).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
getNarrative()
Alternative method getter for field's Additional Informationjava.lang.String
getType()
Alternative method getter for field's Instruction Codejava.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 Field23E
newInstance(Field23E 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.Field23E
setAdditionalInformation(java.lang.String component2)
Set the Additional Information (component 2).Field23E
setCode(java.lang.String component1)
Deprecated.Field23E
setComponent1(java.lang.String component1)
Set the component 1 (Instruction Code).Field23E
setComponent2(java.lang.String component2)
Set the component 2 (Additional Information).Field23E
setInstructionCode(java.lang.String component1)
Set the Instruction Code (component 1).Field23E
setNarrative(java.lang.String component2)
Alternative method setter for field's Additional InformationField23E
setType(java.lang.String component1)
Alternative method setter for field's Instruction Codestatic 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 23E.- See Also:
- Constant Field Values
-
F_23E
public static final java.lang.String F_23E
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
-
INSTRUCTION_CODE
public static final java.lang.Integer INSTRUCTION_CODE
Component number for the Instruction Code subfield.
-
TYPE
public static final java.lang.Integer TYPE
Alternative constant name for field's Instruction Code Component number.- See Also:
INSTRUCTION_CODE
-
CODE
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer CODE
Deprecated.Alternative (DEPRECATED) constant name for field's Instruction Code Component number.- See Also:
INSTRUCTION_CODE
-
ADDITIONAL_INFORMATION
public static final java.lang.Integer ADDITIONAL_INFORMATION
Component number for the Additional Information subfield.
-
NARRATIVE
public static final java.lang.Integer NARRATIVE
Alternative constant name for field's Additional Information Component number.- See Also:
ADDITIONAL_INFORMATION
-
-
Constructor Detail
-
Field23E
public Field23E()
Default constructor. Creates a new field setting all components to null.
-
Field23E
public Field23E(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
-
Field23E
public Field23E(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 Field23E newInstance(Field23E 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 (Instruction Code).- Returns:
- the component 1
-
getInstructionCode
public java.lang.String getInstructionCode()
Gets the Instruction Code (component 1).- Returns:
- the Instruction Code from component 1
-
getType
public java.lang.String getType()
Alternative method getter for field's Instruction Code- Since:
- 9.2.7
- See Also:
getInstructionCode()
-
getCode
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getCode()
Deprecated.Alternative DEPRECATED method getter for field's Instruction Code- Since:
- 9.2.7
- See Also:
getInstructionCode()
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Additional Information).- Returns:
- the component 2
-
getAdditionalInformation
public java.lang.String getAdditionalInformation()
Gets the Additional Information (component 2).- Returns:
- the Additional Information from component 2
-
getNarrative
public java.lang.String getNarrative()
Alternative method getter for field's Additional Information- Since:
- 9.2.7
- See Also:
getAdditionalInformation()
-
setComponent1
public Field23E setComponent1(java.lang.String component1)
Set the component 1 (Instruction Code).- Parameters:
component1
- the Instruction Code to set- Returns:
- the field object to enable build pattern
-
setInstructionCode
public Field23E setInstructionCode(java.lang.String component1)
Set the Instruction Code (component 1).- Parameters:
component1
- the Instruction Code to set- Returns:
- the field object to enable build pattern
-
setType
public Field23E setType(java.lang.String component1)
Alternative method setter for field's Instruction Code- Parameters:
component1
- the Instruction Code to set- Returns:
- the field object to enable build pattern
- See Also:
setInstructionCode(String)
-
setCode
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field23E setCode(java.lang.String component1)
Deprecated.Alternative DEPRECATED method setter for field's Instruction Code- Parameters:
component1
- the Instruction Code to set- Returns:
- the field object to enable build pattern
- See Also:
setInstructionCode(String)
-
setComponent2
public Field23E setComponent2(java.lang.String component2)
Set the component 2 (Additional Information).- Parameters:
component2
- the Additional Information to set- Returns:
- the field object to enable build pattern
-
setAdditionalInformation
public Field23E setAdditionalInformation(java.lang.String component2)
Set the Additional Information (component 2).- Parameters:
component2
- the Additional Information to set- Returns:
- the field object to enable build pattern
-
setNarrative
public Field23E setNarrative(java.lang.String component2)
Alternative method setter for field's Additional Information- Parameters:
component2
- the Additional Information to set- Returns:
- the field object to enable build pattern
- See Also:
setAdditionalInformation(String)
-
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 Field23E 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 Field23E get(SwiftMessage msg)
Gets the first instance of Field23E 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<Field23E> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field23E 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<Field23E> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field23E 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 Field23E fromJson(java.lang.String json)
This method deserializes the JSON data into a Field23E 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)
-
-