@Generated public class Field130 extends Field implements java.io.Serializable, MultiLineField
Model and parser for field 130 of a SWIFT MT message.
Subfields (components) Data types
Long
String
Long
String
Structure definition
/2!n/65x$/2!n/65x
/S/S$/S/S
NSNS
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_130
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
HEADING_CODE
Component number for the Heading Code subfield.
|
static java.lang.Integer |
HEADING_CODE_2
Component number for the Heading Code 2 subfield.
|
static java.lang.Integer |
HEADING_TEXT
Component number for the Heading Text subfield.
|
static java.lang.Integer |
HEADING_TEXT_2
Component number for the Heading Text 2 subfield.
|
static java.lang.String |
NAME
Constant with the field name 130.
|
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 |
---|
Field130()
Default constructor.
|
Field130(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field130(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 Field130 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field130 object.
|
static Field130 |
get(SwiftMessage msg)
Gets the first instance of Field130 in the given message.
|
static Field130 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field130> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field130 in the given message
an empty list is returned if none found.
|
static java.util.List<Field130> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field130 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Heading Code).
|
java.lang.Long |
getComponent1AsLong()
Get the component 1 as Long
|
java.lang.Number |
getComponent1AsNumber()
Deprecated.
|
java.lang.String |
getComponent2()
Gets the component 2 (Heading Text).
|
java.lang.String |
getComponent3()
Gets the component 3 (Heading Code 2).
|
java.lang.Long |
getComponent3AsLong()
Get the component 3 as Long
|
java.lang.Number |
getComponent3AsNumber()
Deprecated.
|
java.lang.String |
getComponent4()
Gets the component 4 (Heading Text 2).
|
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 |
getHeadingCode()
Gets the Heading Code (component 1).
|
java.lang.String |
getHeadingCode2()
Gets the Heading Code 2 (component 3).
|
java.lang.Long |
getHeadingCode2AsLong()
Get the Heading Code 2 (component 3) as Long
|
java.lang.Number |
getHeadingCode2AsNumber()
Deprecated.
|
java.lang.Long |
getHeadingCodeAsLong()
Get the Heading Code (component 1) as Long
|
java.lang.Number |
getHeadingCodeAsNumber()
Deprecated.
|
java.lang.String |
getHeadingText()
Gets the Heading Text (component 2).
|
java.lang.String |
getHeadingText2()
Gets the Heading Text 2 (component 4).
|
java.lang.String |
getLine(int line)
Returns a specific line from the field's value.
|
java.lang.String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
java.util.List<java.lang.String> |
getLines()
Returns the field value split into lines.
|
java.util.List<java.lang.String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
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 Field130 |
newInstance(Field130 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.
|
Field130 |
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
|
Field130 |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Heading Code (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field130 |
setComponent1(java.lang.String component1)
Set the component 1 (Heading Code).
|
Field130 |
setComponent2(java.lang.String component2)
Set the component 2 (Heading Text).
|
Field130 |
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
|
Field130 |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Heading Code 2 (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field130 |
setComponent3(java.lang.String component3)
Set the component 3 (Heading Code 2).
|
Field130 |
setComponent4(java.lang.String component4)
Set the component 4 (Heading Text 2).
|
Field130 |
setHeadingCode(java.lang.Long component1)
Set the Heading Code (component 1) from a Long object.
|
Field130 |
setHeadingCode(java.lang.Number component1)
Alternative method setter for field's Heading Code (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field130 |
setHeadingCode(java.lang.String component1)
Set the Heading Code (component 1).
|
Field130 |
setHeadingCode2(java.lang.Long component3)
Set the Heading Code 2 (component 3) from a Long object.
|
Field130 |
setHeadingCode2(java.lang.Number component3)
Alternative method setter for field's Heading Code 2 (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field130 |
setHeadingCode2(java.lang.String component3)
Set the Heading Code 2 (component 3).
|
Field130 |
setHeadingText(java.lang.String component2)
Set the Heading Text (component 2).
|
Field130 |
setHeadingText2(java.lang.String component4)
Set the Heading Text 2 (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.
|
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_130
@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 HEADING_CODE
public static final java.lang.Integer HEADING_TEXT
public static final java.lang.Integer HEADING_CODE_2
public static final java.lang.Integer HEADING_TEXT_2
public Field130()
public Field130(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field130(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field130 newInstance(Field130 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 getHeadingCode()
public java.lang.Long getHeadingCodeAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getHeadingCodeAsNumber()
getComponent1AsLong()
to get the proper value.getHeadingCodeAsLong()
public java.lang.String getComponent2()
public java.lang.String getHeadingText()
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 getHeadingCode2()
public java.lang.Long getHeadingCode2AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getHeadingCode2AsNumber()
getComponent3AsLong()
to get the proper value.getHeadingCode2AsLong()
public java.lang.String getComponent4()
public java.lang.String getHeadingText2()
public Field130 setComponent1(java.lang.String component1)
component1
- the Heading Code to setpublic Field130 setComponent1(java.lang.Long component1)
component1
- the Long with the Heading Code content to setsetComponent1(String)
public Field130 setComponent1(java.lang.Number component1)
component1
- the Number with the Heading Code content to setsetHeadingCode(java.lang.Long)
public Field130 setHeadingCode(java.lang.String component1)
component1
- the Heading Code to setpublic Field130 setHeadingCode(java.lang.Long component1)
component1
- Long with the Heading Code content to setsetComponent1(java.lang.Long)
public Field130 setHeadingCode(java.lang.Number component1)
component1
- the Number with the Heading Code content to setsetHeadingCode(java.lang.Long)
public Field130 setComponent2(java.lang.String component2)
component2
- the Heading Text to setpublic Field130 setHeadingText(java.lang.String component2)
component2
- the Heading Text to setpublic Field130 setComponent3(java.lang.String component3)
component3
- the Heading Code 2 to setpublic Field130 setComponent3(java.lang.Long component3)
component3
- the Long with the Heading Code 2 content to setsetComponent3(String)
public Field130 setComponent3(java.lang.Number component3)
component3
- the Number with the Heading Code 2 content to setsetHeadingCode2(java.lang.Long)
public Field130 setHeadingCode2(java.lang.String component3)
component3
- the Heading Code 2 to setpublic Field130 setHeadingCode2(java.lang.Long component3)
component3
- Long with the Heading Code 2 content to setsetComponent3(java.lang.Long)
public Field130 setHeadingCode2(java.lang.Number component3)
component3
- the Number with the Heading Code 2 content to setsetHeadingCode2(java.lang.Long)
public Field130 setComponent4(java.lang.String component4)
component4
- the Heading Text 2 to setpublic Field130 setHeadingText2(java.lang.String component4)
component4
- the Heading Text 2 to setpublic java.lang.String getName()
public static Field130 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field130 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field130> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field130> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getLine(int line)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1MultiLineField.getLine(int)
public java.lang.String getLine(int line, int offset)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting linesMultiLineField.getLine(int, int)
public java.util.List<java.lang.String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public java.util.List<java.lang.String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public java.util.List<java.lang.String> getLinesBetween(int start, int end)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startMultiLineField.getLinesBetween(int, int )
public java.util.List<java.lang.String> getLinesBetween(int start, int end, int offset)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startoffset
- an optional component number used as offset when counting linesMultiLineField.getLinesBetween(int start, int end, int offset)
public static Field130 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)