Class Field26A
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field26A
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field26A extends Field implements java.io.Serializable
SWIFT MT Field 26A.Model and parser for field 26A of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Number1:
String
- Component 2: Number2:
String
Structure definition
- validation pattern:
<VAR-SEQU-2>
- 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.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.String
F_26A
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 26A.static java.lang.Integer
NUMBER
Deprecated.static java.lang.Integer
NUMBER1
Component number for the Number1 subfield.static java.lang.Integer
NUMBER2
Component number for the Number2 subfield.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.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field26A()
Default constructor.Field26A(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field26A(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 Field26A
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field26A object.static Field26A
get(SwiftMessage msg)
Gets the first instance of Field26A in the given message.static Field26A
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field26A>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field26A in the given message an empty list is returned if none found.static java.util.List<Field26A>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field26A from the given block an empty list is returned if none found.java.lang.String
getComponent1()
Gets the component 1 (Number1).java.lang.String
getComponent2()
Gets the component 2 (Number2).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
getNumber()
Deprecated.java.lang.String
getNumber1()
Gets the Number1 (component 1).java.lang.String
getNumber2()
Gets the Number2 (component 2).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 Field26A
newInstance(Field26A 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.Field26A
setComponent1(java.lang.String component1)
Set the component 1 (Number1).Field26A
setComponent2(java.lang.String component2)
Set the component 2 (Number2).Field26A
setNumber(java.lang.String number)
Deprecated.Field26A
setNumber1(java.lang.String component1)
Set the Number1 (component 1).Field26A
setNumber2(java.lang.String component2)
Set the Number2 (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-
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 26A.- See Also:
- Constant Field Values
-
F_26A
public static final java.lang.String F_26A
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
-
NUMBER1
public static final java.lang.Integer NUMBER1
Component number for the Number1 subfield.
-
NUMBER2
public static final java.lang.Integer NUMBER2
Component number for the Number2 subfield.
-
NUMBER
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer NUMBER
Deprecated.Component number for the Number 1 subfield. IMPORTANT: this constant is kept for compatibility, but getting component 1 will now return only part of the value (the Number 1) as the Form is now a separate component.
-
-
Constructor Detail
-
Field26A
public Field26A()
Default constructor. Creates a new field setting all components to null.
-
Field26A
public Field26A(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
-
Field26A
public Field26A(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 Field26A newInstance(Field26A 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 (Number1).- Returns:
- the component 1
-
getNumber1
public java.lang.String getNumber1()
Gets the Number1 (component 1).- Returns:
- the Number1 from component 1
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Number2).- Returns:
- the component 2
-
getNumber2
public java.lang.String getNumber2()
Gets the Number2 (component 2).- Returns:
- the Number2 from component 2
-
setComponent1
public Field26A setComponent1(java.lang.String component1)
Set the component 1 (Number1).- Parameters:
component1
- the Number1 to set- Returns:
- the field object to enable build pattern
-
setNumber1
public Field26A setNumber1(java.lang.String component1)
Set the Number1 (component 1).- Parameters:
component1
- the Number1 to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field26A setComponent2(java.lang.String component2)
Set the component 2 (Number2).- Parameters:
component2
- the Number2 to set- Returns:
- the field object to enable build pattern
-
setNumber2
public Field26A setNumber2(java.lang.String component2)
Set the Number2 (component 2).- Parameters:
component2
- the Number2 to set- Returns:
- the field object to enable build pattern
-
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 Field26A 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 Field26A get(SwiftMessage msg)
Gets the first instance of Field26A 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<Field26A> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field26A 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<Field26A> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field26A 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 Field26A fromJson(java.lang.String json)
This method deserializes the JSON data into a Field26A 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)
-
getNumber
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getNumber()
Deprecated.Gets the Number (components 1 and 2) as a unit This method is a wrapper forgetValue
. Note that in previous versions, this field had only one component and now has two because it's what the SWIFT specification indicates.- Returns:
- the concatenated values of component 1 and 2
- See Also:
getValue()
-
setNumber
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field26A setNumber(java.lang.String number)
Deprecated.Sets the Number (components 1 and 2) as a unit This method is a wrapper forparse
. Note that in previous versions, this field had only one component and now has two because it's what the SWIFT specification indicates.- Parameters:
number
- the new expected value for components 1 and 2 concatenated- Returns:
- the field object to enable build pattern
- See Also:
parse(String)
-
-