@Generated public class Field26E extends Field implements java.io.Serializable
Model and parser for field 26E of a SWIFT MT message.
Subfields (components) Data types
Long
Structure definition
3n
S
N
This class complies with standard release SRU2021
Modifier and Type | Field and 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.
Use
typesPattern() 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.
|
static java.lang.Integer |
NUMBER_OF_AMENDMENT
Component number for the Number Of Amendment subfield.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
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 |
---|
Field26E()
Default constructor.
|
Field26E(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field26E(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 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()
Alternative method getter for field's Number Of Amendment
|
java.lang.Long |
getAutomaticExtensionNotificationPeriodAsLong()
Alternative method getter for field's Number Of Amendment as Long
|
java.lang.Number |
getAutomaticExtensionNotificationPeriodAsNumber()
Deprecated.
|
java.lang.String |
getComponent1()
Gets the component 1 (Number Of Amendment).
|
java.lang.Long |
getComponent1AsLong()
Get the component 1 as Long
|
java.lang.Number |
getComponent1AsNumber()
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 |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getNumber()
Deprecated.
|
java.lang.Long |
getNumberAsLong()
Deprecated.
|
java.lang.Number |
getNumberAsNumber()
Deprecated.
|
java.lang.String |
getNumberOfAmendment()
Gets the Number Of Amendment (component 1).
|
java.lang.Long |
getNumberOfAmendmentAsLong()
Get the Number Of Amendment (component 1) as Long
|
java.lang.Number |
getNumberOfAmendmentAsNumber()
Deprecated.
|
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 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)
Alternative method setter for field's Number Of Amendment from a Long object.
|
Field26E |
setAutomaticExtensionNotificationPeriod(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 |
setAutomaticExtensionNotificationPeriod(java.lang.String component1)
Alternative method setter for field's Number Of Amendment
|
Field26E |
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.
|
Field26E |
setNumber(java.lang.Number component1)
Deprecated.
|
Field26E |
setNumber(java.lang.String component1)
Deprecated.
|
Field26E |
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
|
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_26E
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer NUMBER_OF_AMENDMENT
public static final java.lang.Integer AUTOMATIC_EXTENSION_NOTIFICATION_PERIOD
NUMBER_OF_AMENDMENT
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer NUMBER
NUMBER_OF_AMENDMENT
public Field26E()
public Field26E(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field26E(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field26E newInstance(Field26E 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(phase2=SRU2022) public java.lang.String componentsPattern()
typesPattern()
instead.Field
typesPattern()
instead.componentsPattern
in class Field
Field.typesPattern()
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.Long getComponent1AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent1AsNumber()
getComponent1AsLong()
to get the proper value.getComponent1AsLong()
public java.lang.String getNumberOfAmendment()
public java.lang.String getAutomaticExtensionNotificationPeriod()
getNumberOfAmendment()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getNumber()
getNumberOfAmendment()
public java.lang.Long getNumberOfAmendmentAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getNumberOfAmendmentAsNumber()
getComponent1AsLong()
to get the proper value.getNumberOfAmendmentAsLong()
public java.lang.Long getAutomaticExtensionNotificationPeriodAsLong()
getNumberOfAmendmentAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getAutomaticExtensionNotificationPeriodAsNumber()
getComponent1AsLong()
to get the proper value.getNumberOfAmendmentAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Long getNumberAsLong()
getNumberOfAmendmentAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getNumberAsNumber()
getComponent1AsLong()
to get the proper value.getNumberOfAmendmentAsLong()
public Field26E setComponent1(java.lang.String component1)
component1
- the Number Of Amendment to setpublic Field26E setComponent1(java.lang.Long component1)
component1
- the Long with the Number Of Amendment content to setsetComponent1(String)
public Field26E setComponent1(java.lang.Number component1)
component1
- the Number with the Number Of Amendment content to setsetNumberOfAmendment(java.lang.Long)
public Field26E setNumberOfAmendment(java.lang.String component1)
component1
- the Number Of Amendment to setpublic Field26E setNumberOfAmendment(java.lang.Long component1)
component1
- Long with the Number Of Amendment content to setsetComponent1(java.lang.Long)
public Field26E setNumberOfAmendment(java.lang.Number component1)
component1
- the Number with the Number Of Amendment content to setsetNumberOfAmendment(java.lang.Long)
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.String component1)
component1
- the Number Of Amendment to setsetNumberOfAmendment(String)
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.Long component1)
component1
- Long with the Number Of Amendment content to setsetComponent1(java.lang.Long)
public Field26E setAutomaticExtensionNotificationPeriod(java.lang.Number component1)
component1
- the Number with the Number Of Amendment content to setsetNumberOfAmendment(java.lang.Long)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field26E setNumber(java.lang.String component1)
component1
- the Number Of Amendment to setsetNumberOfAmendment(String)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field26E setNumber(java.lang.Long component1)
component1
- Long with the Number Of Amendment content to setsetComponent1(java.lang.Long)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field26E setNumber(java.lang.Number component1)
component1
- the Number with the Number Of Amendment content to setsetNumberOfAmendment(java.lang.Long)
public java.lang.String getName()
public static Field26E get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field26E get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field26E> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field26E> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field26E fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)