@Generated public class Field38G extends Field implements java.io.Serializable
Model and parser for field 38G of a SWIFT MT message.
Subfields (components) Data types
Long
String
Long
String
Structure definition
2n1a/2n1a
NS/NS
NSNS
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.String |
F_38G
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 38G
|
static java.lang.Integer |
NUMBER_FROM
Component number for the Number From subfield
|
static java.lang.Integer |
NUMBER_TO
Component number for the Number To subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PERIOD_FROM
Component number for the Period From subfield
|
static java.lang.Integer |
PERIOD_TO
Component number for the Period To subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.
|
components
Constructor and Description |
---|
Field38G()
Default constructor.
|
Field38G(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field38G(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.
|
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 Field38G |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field38G object.
|
static Field38G |
get(SwiftMessage msg)
Gets the first instance of Field38G in the given message.
|
static Field38G |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field38G> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field38G in the given message
an empty list is returned if none found.
|
static java.util.List<Field38G> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field38G from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Number From).
|
java.lang.Long |
getComponent1AsLong()
Get the component 1 as Long
|
java.lang.Number |
getComponent1AsNumber()
Deprecated.
|
java.lang.String |
getComponent2()
Gets the component 2 (Period From).
|
java.lang.String |
getComponent3()
Gets the component 3 (Number To).
|
java.lang.Long |
getComponent3AsLong()
Get the component 3 as Long
|
java.lang.Number |
getComponent3AsNumber()
Deprecated.
|
java.lang.String |
getComponent4()
Gets the component 4 (Period To).
|
protected 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 |
getNumberFrom()
Gets the Number From (component 1).
|
java.lang.Long |
getNumberFromAsLong()
Get the Number From (component 1) as Long
|
java.lang.Number |
getNumberFromAsNumber()
Deprecated.
|
java.lang.String |
getNumberTo()
Gets the Number To (component 3).
|
java.lang.Long |
getNumberToAsLong()
Get the Number To (component 3) as Long
|
java.lang.Number |
getNumberToAsNumber()
Deprecated.
|
java.lang.String |
getPeriodFrom()
Gets the Period From (component 2).
|
java.lang.String |
getPeriodTo()
Gets the Period To (component 4).
|
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 Field38G |
newInstance(Field38G 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
|
Field38G |
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
|
Field38G |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Number From (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38G |
setComponent1(java.lang.String component1)
Set the component 1 (Number From).
|
Field38G |
setComponent2(java.lang.String component2)
Set the component 2 (Period From).
|
Field38G |
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
|
Field38G |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Number To (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38G |
setComponent3(java.lang.String component3)
Set the component 3 (Number To).
|
Field38G |
setComponent4(java.lang.String component4)
Set the component 4 (Period To).
|
Field38G |
setNumberFrom(java.lang.Long component1)
Set the Number From (component 1) from a Long object.
|
Field38G |
setNumberFrom(java.lang.Number component1)
Alternative method setter for field's Number From (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38G |
setNumberFrom(java.lang.String component1)
Set the Number From (component 1).
|
Field38G |
setNumberTo(java.lang.Long component3)
Set the Number To (component 3) from a Long object.
|
Field38G |
setNumberTo(java.lang.Number component3)
Alternative method setter for field's Number To (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field38G |
setNumberTo(java.lang.String component3)
Set the Number To (component 3).
|
Field38G |
setPeriodFrom(java.lang.String component2)
Set the Period From (component 2).
|
Field38G |
setPeriodTo(java.lang.String component4)
Set the Period To (component 4).
|
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
This method returns a letter representing the type for each component in the Field.
|
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_38G
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN
,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer NUMBER_FROM
public static final java.lang.Integer PERIOD_FROM
public static final java.lang.Integer NUMBER_TO
public static final java.lang.Integer PERIOD_TO
public Field38G()
public Field38G(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field38G(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field38G newInstance(Field38G 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 final java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
typesPattern()
public final java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
TYPES_PATTERN
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
protected 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 getNumberFrom()
public java.lang.Long getNumberFromAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getNumberFromAsNumber()
getComponent1AsLong()
to get the proper value.getNumberFromAsLong()
public java.lang.String getComponent2()
public java.lang.String getPeriodFrom()
public java.lang.String getComponent3()
public java.lang.Long getComponent3AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent3AsNumber()
getComponent3AsLong()
to get the proper value.getComponent3AsLong()
public java.lang.String getNumberTo()
public java.lang.Long getNumberToAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getNumberToAsNumber()
getComponent3AsLong()
to get the proper value.getNumberToAsLong()
public java.lang.String getComponent4()
public java.lang.String getPeriodTo()
public Field38G setComponent1(java.lang.String component1)
component1
- the Number From to setpublic Field38G setComponent1(java.lang.Long component1)
component1
- the Long with the Number From content to setsetComponent1(String)
public Field38G setComponent1(java.lang.Number component1)
component1
- the Number with the Number From content to setsetNumberFrom(java.lang.Long)
public Field38G setNumberFrom(java.lang.String component1)
component1
- the Number From to setpublic Field38G setNumberFrom(java.lang.Long component1)
component1
- Long with the Number From content to setsetComponent1(java.lang.Long)
public Field38G setNumberFrom(java.lang.Number component1)
component1
- the Number with the Number From content to setsetNumberFrom(java.lang.Long)
public Field38G setComponent2(java.lang.String component2)
component2
- the Period From to setpublic Field38G setPeriodFrom(java.lang.String component2)
component2
- the Period From to setpublic Field38G setComponent3(java.lang.String component3)
component3
- the Number To to setpublic Field38G setComponent3(java.lang.Long component3)
component3
- the Long with the Number To content to setsetComponent3(String)
public Field38G setComponent3(java.lang.Number component3)
component3
- the Number with the Number To content to setsetNumberTo(java.lang.Long)
public Field38G setNumberTo(java.lang.String component3)
component3
- the Number To to setpublic Field38G setNumberTo(java.lang.Long component3)
component3
- Long with the Number To content to setsetComponent3(java.lang.Long)
public Field38G setNumberTo(java.lang.Number component3)
component3
- the Number with the Number To content to setsetNumberTo(java.lang.Long)
public Field38G setComponent4(java.lang.String component4)
component4
- the Period To to setpublic Field38G setPeriodTo(java.lang.String component4)
component4
- the Period To to setpublic java.lang.String getName()
public static Field38G get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field38G get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field38G> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field38G> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field38G fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)