@Generated public class Field38E extends Field implements java.io.Serializable
Model and parser for field 38E of a SWIFT MT message.
Subfields (components) Data types
Number
String
Structure definition
2n1a
NS
NS
This class complies with standard release SRU2019
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_38E
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 38E
|
static java.lang.Integer |
NUMBER
Component number for the Number subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PERIOD
Component number for the Period subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
Constructor and Description |
---|
Field38E()
Default constructor.
|
Field38E(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field38E(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()
Returns the field components pattern
|
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
Shorthand for
new Tag(NAME, "") |
static Field38E |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field38E object.
|
static Field38E |
get(SwiftMessage msg)
Gets the first instance of Field38E in the given message.
|
static Field38E |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field38E> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field38E in the given message
an empty list is returned if none found.
|
static java.util.List<Field38E> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field38E from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component1 (Number).
|
java.lang.Number |
getComponent1AsNumber()
Get the component1 as Number
|
java.lang.String |
getComponent2()
Gets the component2 (Period).
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getNumber()
Gets the Number (component1).
|
java.lang.Number |
getNumberAsNumber()
Get the Number (component1) as Number
|
java.lang.String |
getPeriod()
Gets the Period (component2).
|
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 Field38E |
newInstance(Field38E source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern
|
Field38E |
setComponent1(java.lang.Number component1)
Set the component1 from a Number object.
|
Field38E |
setComponent1(java.lang.String component1)
Set the component1 (Number).
|
Field38E |
setComponent2(java.lang.String component2)
Set the component2 (Period).
|
Field38E |
setNumber(java.lang.Number component1)
Set the Number (component1) from a Number object.
|
Field38E |
setNumber(java.lang.String component1)
Set the Number (component1).
|
Field38E |
setPeriod(java.lang.String component2)
Set the Period (component2).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_38E
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer NUMBER
public static final java.lang.Integer PERIOD
public Field38E()
public Field38E(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field38E(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field38E newInstance(Field38E 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 fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final 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.lang.String getComponent1()
public java.lang.Number getComponent1AsNumber()
public java.lang.String getNumber()
public java.lang.Number getNumberAsNumber()
public java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getPeriod()
public Field38E setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field38E setComponent1(java.lang.Number component1)
component1
- the Number with the component1 content to setsetComponent1(String)
public Field38E setNumber(java.lang.String component1)
component1
- the Number to setpublic Field38E setNumber(java.lang.Number component1)
component1
- Number with the Number content to setsetComponent1(java.lang.Number)
public Field38E setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field38E setPeriod(java.lang.String component2)
component2
- the Period to setpublic java.lang.String getName()
public static Field38E get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field38E get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field38E> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field38E> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field38E fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)