@Generated public class Field38A extends Field implements java.io.Serializable
Model and parser for field 38A of a SWIFT MT message.
Subfields (components) Data types
Long
Structure definition
3n
S
N
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_38A
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 38A.
|
static java.lang.Integer |
NUMBER
Deprecated.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PERIOD
Component number for the Period subfield.
|
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 |
---|
Field38A()
Default constructor.
|
Field38A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field38A(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 Field38A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field38A object.
|
static Field38A |
get(SwiftMessage msg)
Gets the first instance of Field38A in the given message.
|
static Field38A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field38A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field38A in the given message
an empty list is returned if none found.
|
static java.util.List<Field38A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field38A from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Period).
|
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 |
getPeriod()
Gets the Period (component 1).
|
java.lang.Long |
getPeriodAsLong()
Get the Period (component 1) as Long
|
java.lang.Number |
getPeriodAsNumber()
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 Field38A |
newInstance(Field38A 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.
|
Field38A |
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
|
Field38A |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Period (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38A |
setComponent1(java.lang.String component1)
Set the component 1 (Period).
|
Field38A |
setNumber(java.lang.Long component1)
Deprecated.
|
Field38A |
setNumber(java.lang.Number component1)
Deprecated.
|
Field38A |
setNumber(java.lang.String component1)
Deprecated.
|
Field38A |
setPeriod(java.lang.Long component1)
Set the Period (component 1) from a Long object.
|
Field38A |
setPeriod(java.lang.Number component1)
Alternative method setter for field's Period (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38A |
setPeriod(java.lang.String component1)
Set the Period (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_38A
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer PERIOD
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer NUMBER
PERIOD
public Field38A()
public Field38A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field38A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field38A newInstance(Field38A 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(phase3=SRU2023) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
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(phase3=SRU2023) public java.lang.Number getComponent1AsNumber()
getComponent1AsLong()
to get the proper value.getComponent1AsLong()
public java.lang.String getPeriod()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getNumber()
getPeriod()
public java.lang.Long getPeriodAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getPeriodAsNumber()
getComponent1AsLong()
to get the proper value.getPeriodAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Long getNumberAsLong()
getPeriodAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumberAsNumber()
getComponent1AsLong()
to get the proper value.getPeriodAsLong()
public Field38A setComponent1(java.lang.String component1)
component1
- the Period to setpublic Field38A setComponent1(java.lang.Long component1)
component1
- the Long with the Period content to setsetComponent1(String)
public Field38A setComponent1(java.lang.Number component1)
component1
- the Number with the Period content to setsetPeriod(java.lang.Long)
public Field38A setPeriod(java.lang.String component1)
component1
- the Period to setpublic Field38A setPeriod(java.lang.Long component1)
component1
- Long with the Period content to setsetComponent1(java.lang.Long)
public Field38A setPeriod(java.lang.Number component1)
component1
- the Number with the Period content to setsetPeriod(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field38A setNumber(java.lang.String component1)
component1
- the Period to setsetPeriod(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field38A setNumber(java.lang.Long component1)
component1
- Long with the Period content to setsetComponent1(java.lang.Long)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field38A setNumber(java.lang.Number component1)
component1
- the Number with the Period content to setsetPeriod(java.lang.Long)
public java.lang.String getName()
public static Field38A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field38A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field38A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field38A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field38A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)