Class Field26E
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field26E
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field26E extends Field implements java.io.Serializable
SWIFT MT Field 26E.Model and parser for field 26E of a SWIFT MT message.
Subfields (components) Data types
- Component 1: NumberOfAmendment:
Long
Structure definition
- validation pattern:
3n
- parser pattern:
S
- components pattern:
N
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
AUTOMATIC_EXTENSION_NOTIFICATION_PERIOD
Alternative constant name for field's Number Of Amendment Component number.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.String
F_26E
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 26E.static java.lang.Integer
NUMBER
Deprecated.use #NUMBER_OF_AMENDMENT insteadstatic java.lang.Integer
NUMBER_OF_AMENDMENT
Component number for the Number Of Amendment 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 Field26E()
Default constructor.Field26E(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field26E(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 Field26E
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field26E object.static Field26E
get(SwiftMessage msg)
Gets the first instance of Field26E in the given message.static Field26E
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field26E>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field26E in the given message an empty list is returned if none found.static java.util.List<Field26E>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field26E from the given block an empty list is returned if none found.java.lang.String
getAutomaticExtensionNotificationPeriod()
Deprecated.use #getNumberOfAmendment() insteadjava.lang.Long
getAutomaticExtensionNotificationPeriodAsLong()
Deprecated.use #getNumberOfAmendmentAsLong() insteadjava.lang.Number
getAutomaticExtensionNotificationPeriodAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() insteadjava.lang.String
getComponent1()
Gets the component 1 (Number Of Amendment).java.lang.Long
getComponent1AsLong()
Get the component 1 as Longjava.lang.Number
getComponent1AsNumber()
Deprecated.use #getComponent1AsLong() insteadjava.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.use #getNumberOfAmendment() insteadjava.lang.Long
getNumberAsLong()
Deprecated.use #getNumberOfAmendmentAsLong() insteadjava.lang.Number
getNumberAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() insteadjava.lang.String
getNumberOfAmendment()
Gets the Number Of Amendment (component 1).java.lang.Long
getNumberOfAmendmentAsLong()
Get the Number Of Amendment (component 1) as Longjava.lang.Number
getNumberOfAmendmentAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() insteadjava.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 Field26E
newInstance(Field26E 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.Field26E
setAutomaticExtensionNotificationPeriod(java.lang.Long component1)
Deprecated.use #setComponent1(java.lang.Long) insteadField26E
setAutomaticExtensionNotificationPeriod(java.lang.Number component1)
Deprecated.use #setNumberOfAmendment(java.lang.Long) insteadField26E
setAutomaticExtensionNotificationPeriod(java.lang.String component1)
Deprecated.use #setNumberOfAmendment(String) insteadField26E
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.Field26E
setComponent1(java.lang.Number component1)
Alternative method setter for field's Number Of Amendment (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field26E
setComponent1(java.lang.String component1)
Set the component 1 (Number Of Amendment).Field26E
setNumber(java.lang.Long component1)
Deprecated.use #setComponent1(java.lang.Long) insteadField26E
setNumber(java.lang.Number component1)
Deprecated.use #setNumberOfAmendment(java.lang.Long) insteadField26E
setNumber(java.lang.String component1)
Deprecated.use #setNumberOfAmendment(String) insteadField26E
setNumberOfAmendment(java.lang.Long component1)
Set the Number Of Amendment (component 1) from a Long object.Field26E
setNumberOfAmendment(java.lang.Number component1)
Alternative method setter for field's Number Of Amendment (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field26E
setNumberOfAmendment(java.lang.String component1)
Set the Number Of Amendment (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 26E.- See Also:
- Constant Field Values
-
F_26E
public static final java.lang.String F_26E
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
NUMBER_OF_AMENDMENT
public static final java.lang.Integer NUMBER_OF_AMENDMENT
Component number for the Number Of Amendment subfield.
-
AUTOMATIC_EXTENSION_NOTIFICATION_PERIOD
public static final java.lang.Integer AUTOMATIC_EXTENSION_NOTIFICATION_PERIOD
Alternative constant name for field's Number Of Amendment Component number.- See Also:
NUMBER_OF_AMENDMENT
-
NUMBER
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer NUMBER
Deprecated.use #NUMBER_OF_AMENDMENT instead
-
-
Constructor Detail
-
Field26E
public Field26E()
Default constructor. Creates a new field setting all components to null.
-
Field26E
public Field26E(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
-
Field26E
public Field26E(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 Field26E newInstance(Field26E 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(phase4=SRU2024) 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 (Number Of Amendment).- Returns:
- the component 1
-
getComponent1AsLong
public java.lang.Long getComponent1AsLong()
Get the component 1 as Long- Returns:
- the component 1 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent1AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent1AsNumber()
Deprecated.use #getComponent1AsLong() instead
-
getNumberOfAmendment
public java.lang.String getNumberOfAmendment()
Gets the Number Of Amendment (component 1).- Returns:
- the Number Of Amendment from component 1
-
getAutomaticExtensionNotificationPeriod
public java.lang.String getAutomaticExtensionNotificationPeriod()
Deprecated.use #getNumberOfAmendment() insteadAlternative method getter for field's Number Of Amendment- Since:
- 9.2.7
-
getNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getNumber()
Deprecated.use #getNumberOfAmendment() insteadAlternative DEPRECATED method getter for field's Number Of Amendment- Since:
- 9.2.7
-
getNumberOfAmendmentAsLong
public java.lang.Long getNumberOfAmendmentAsLong()
Get the Number Of Amendment (component 1) as Long- Returns:
- the Number Of Amendment from component 1 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumberOfAmendmentAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberOfAmendmentAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() instead
-
getAutomaticExtensionNotificationPeriodAsLong
public java.lang.Long getAutomaticExtensionNotificationPeriodAsLong()
Deprecated.use #getNumberOfAmendmentAsLong() instead- Since:
- 9.2.7
-
getAutomaticExtensionNotificationPeriodAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getAutomaticExtensionNotificationPeriodAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() instead
-
getNumberAsLong
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Long getNumberAsLong()
Deprecated.use #getNumberOfAmendmentAsLong() instead
-
getNumberAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberAsNumber()
Deprecated.use #getNumberOfAmendmentAsLong() instead
-
setComponent1
public Field26E setComponent1(java.lang.String component1)
Set the component 1 (Number Of Amendment).- Parameters:
component1
- the Number Of Amendment to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field26E setComponent1(java.lang.Long component1)
Set the component1 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 setComponent1(String) method.- Parameters:
component1
- the Long with the Number Of Amendment content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent1(String)
-
setComponent1
public Field26E setComponent1(java.lang.Number component1)
Alternative method setter for field's Number Of Amendment (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component1
- the Number with the Number Of Amendment content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumberOfAmendment(java.lang.Long)
-
setNumberOfAmendment
public Field26E setNumberOfAmendment(java.lang.String component1)
Set the Number Of Amendment (component 1).- Parameters:
component1
- the Number Of Amendment to set- Returns:
- the field object to enable build pattern
-
setNumberOfAmendment
public Field26E setNumberOfAmendment(java.lang.Long component1)
Set the Number Of Amendment (component 1) from a Long object.- Parameters:
component1
- Long with the Number Of Amendment content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent1(java.lang.Long)
-
setNumberOfAmendment
public Field26E setNumberOfAmendment(java.lang.Number component1)
Alternative method setter for field's Number Of Amendment (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component1
- the Number with the Number Of Amendment content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumberOfAmendment(java.lang.Long)
-
setAutomaticExtensionNotificationPeriod
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.String component1)
Deprecated.use #setNumberOfAmendment(String) instead
-
setAutomaticExtensionNotificationPeriod
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.Long component1)
Deprecated.use #setComponent1(java.lang.Long) instead- Since:
- 9.2.7
-
setAutomaticExtensionNotificationPeriod
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.Number component1)
Deprecated.use #setNumberOfAmendment(java.lang.Long) instead
-
setNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field26E setNumber(java.lang.String component1)
Deprecated.use #setNumberOfAmendment(String) instead
-
setNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field26E setNumber(java.lang.Long component1)
Deprecated.use #setComponent1(java.lang.Long) instead- Since:
- 9.2.7
-
setNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field26E setNumber(java.lang.Number component1)
Deprecated.use #setNumberOfAmendment(java.lang.Long) instead
-
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 Field26E 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 Field26E get(SwiftMessage msg)
Gets the first instance of Field26E 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<Field26E> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field26E 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<Field26E> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field26E 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 Field26E fromJson(java.lang.String json)
This method deserializes the JSON data into a Field26E 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)
-
-