@Generated public class Field59F extends Field implements java.io.Serializable, MultiLineField
Model and parser for field 59F of a SWIFT MT message.
Subfields (components) Data types
String
Long
String
Long
String
Long
String
Long
String
Structure definition
CUSTOM
[/S$]N/S[$N/S$]0-3
SNSNSNSNS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACCOUNT
Component number for the Account subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_59F
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 59F.
|
static java.lang.Integer |
NAME_AND_ADDRESS_1
Component number for the Name And Address 1 subfield.
|
static java.lang.Integer |
NAME_AND_ADDRESS_2
Component number for the Name And Address 2 subfield.
|
static java.lang.Integer |
NAME_AND_ADDRESS_3
Component number for the Name And Address 3 subfield.
|
static java.lang.Integer |
NAME_AND_ADDRESS_4
Component number for the Name And Address 4 subfield.
|
static java.lang.Integer |
NUMBER_1
Component number for the Number 1 subfield.
|
static java.lang.Integer |
NUMBER_2
Component number for the Number 2 subfield.
|
static java.lang.Integer |
NUMBER_3
Component number for the Number 3 subfield.
|
static java.lang.Integer |
NUMBER_4
Component number for the Number 4 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, labelMap
Constructor and Description |
---|
Field59F()
Default constructor.
|
Field59F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field59F(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. |
boolean |
contains(int lineIdentifier)
Check if the line identified by a given number is present.
|
java.util.List<java.lang.String> |
detailsByNumber(int lineIdentifier)
Get the details (right part of the line) based on the line identification number.
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field59F |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field59F object.
|
static Field59F |
get(SwiftMessage msg)
Gets the first instance of Field59F in the given message.
|
static Field59F |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
java.lang.String |
getAccount()
Gets the Account (component 1) removing its starting slashes if any.
|
static java.util.List<Field59F> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field59F in the given message
an empty list is returned if none found.
|
static java.util.List<Field59F> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field59F from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Account).
|
java.lang.String |
getComponent2()
Gets the component 2 (Number 1).
|
java.lang.Long |
getComponent2AsLong()
Get the component 2 as Long
|
java.lang.Number |
getComponent2AsNumber()
Deprecated.
|
java.lang.String |
getComponent3()
Gets the component 3 (Name And Address 1).
|
java.lang.String |
getComponent4()
Gets the component 4 (Number 2).
|
java.lang.Long |
getComponent4AsLong()
Get the component 4 as Long
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
java.lang.String |
getComponent5()
Gets the component 5 (Name And Address 2).
|
java.lang.String |
getComponent6()
Gets the component 6 (Number 3).
|
java.lang.Long |
getComponent6AsLong()
Get the component 6 as Long
|
java.lang.Number |
getComponent6AsNumber()
Deprecated.
|
java.lang.String |
getComponent7()
Gets the component 7 (Name And Address 3).
|
java.lang.String |
getComponent8()
Gets the component 8 (Number 4).
|
java.lang.Long |
getComponent8AsLong()
Get the component 8 as Long
|
java.lang.Number |
getComponent8AsNumber()
Deprecated.
|
java.lang.String |
getComponent9()
Gets the component 9 (Name And Address 4).
|
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.
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
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 |
getNameAndAddress1()
Gets the Name And Address 1 (component 3).
|
java.lang.String |
getNameAndAddress2()
Gets the Name And Address 2 (component 5).
|
java.lang.String |
getNameAndAddress3()
Gets the Name And Address 3 (component 7).
|
java.lang.String |
getNameAndAddress4()
Gets the Name And Address 4 (component 9).
|
java.lang.String |
getNumber1()
Gets the Number 1 (component 2).
|
java.lang.Long |
getNumber1AsLong()
Get the Number 1 (component 2) as Long
|
java.lang.Number |
getNumber1AsNumber()
Deprecated.
|
java.lang.String |
getNumber2()
Gets the Number 2 (component 4).
|
java.lang.Long |
getNumber2AsLong()
Get the Number 2 (component 4) as Long
|
java.lang.Number |
getNumber2AsNumber()
Deprecated.
|
java.lang.String |
getNumber3()
Gets the Number 3 (component 6).
|
java.lang.Long |
getNumber3AsLong()
Get the Number 3 (component 6) as Long
|
java.lang.Number |
getNumber3AsNumber()
Deprecated.
|
java.lang.String |
getNumber4()
Gets the Number 4 (component 8).
|
java.lang.Long |
getNumber4AsLong()
Get the Number 4 (component 8) as Long
|
java.lang.Number |
getNumber4AsNumber()
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 Field59F |
newInstance(Field59F 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.
|
Field59F |
setAccount(java.lang.String component1)
Set the Account (component 1).
|
Field59F |
setComponent1(java.lang.String component1)
Set the component 1 (Account).
|
Field59F |
setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
|
Field59F |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Number 1 (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setComponent2(java.lang.String component2)
Set the component 2 (Number 1).
|
Field59F |
setComponent3(java.lang.String component3)
Set the component 3 (Name And Address 1).
|
Field59F |
setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
|
Field59F |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Number 2 (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setComponent4(java.lang.String component4)
Set the component 4 (Number 2).
|
Field59F |
setComponent5(java.lang.String component5)
Set the component 5 (Name And Address 2).
|
Field59F |
setComponent6(java.lang.Long component6)
Set the component6 from a Long object.
|
Field59F |
setComponent6(java.lang.Number component6)
Alternative method setter for field's Number 3 (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setComponent6(java.lang.String component6)
Set the component 6 (Number 3).
|
Field59F |
setComponent7(java.lang.String component7)
Set the component 7 (Name And Address 3).
|
Field59F |
setComponent8(java.lang.Long component8)
Set the component8 from a Long object.
|
Field59F |
setComponent8(java.lang.Number component8)
Alternative method setter for field's Number 4 (component 8) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setComponent8(java.lang.String component8)
Set the component 8 (Number 4).
|
Field59F |
setComponent9(java.lang.String component9)
Set the component 9 (Name And Address 4).
|
Field59F |
setNameAndAddress1(java.lang.String component3)
Set the Name And Address 1 (component 3).
|
Field59F |
setNameAndAddress2(java.lang.String component5)
Set the Name And Address 2 (component 5).
|
Field59F |
setNameAndAddress3(java.lang.String component7)
Set the Name And Address 3 (component 7).
|
Field59F |
setNameAndAddress4(java.lang.String component9)
Set the Name And Address 4 (component 9).
|
Field59F |
setNumber1(java.lang.Long component2)
Set the Number 1 (component 2) from a Long object.
|
Field59F |
setNumber1(java.lang.Number component2)
Alternative method setter for field's Number 1 (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setNumber1(java.lang.String component2)
Set the Number 1 (component 2).
|
Field59F |
setNumber2(java.lang.Long component4)
Set the Number 2 (component 4) from a Long object.
|
Field59F |
setNumber2(java.lang.Number component4)
Alternative method setter for field's Number 2 (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setNumber2(java.lang.String component4)
Set the Number 2 (component 4).
|
Field59F |
setNumber3(java.lang.Long component6)
Set the Number 3 (component 6) from a Long object.
|
Field59F |
setNumber3(java.lang.Number component6)
Alternative method setter for field's Number 3 (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setNumber3(java.lang.String component6)
Set the Number 3 (component 6).
|
Field59F |
setNumber4(java.lang.Long component8)
Set the Number 4 (component 8) from a Long object.
|
Field59F |
setNumber4(java.lang.Number component8)
Alternative method setter for field's Number 4 (component 8) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field59F |
setNumber4(java.lang.String component8)
Set the Number 4 (component 8).
|
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_59F
@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 ACCOUNT
public static final java.lang.Integer NUMBER_1
public static final java.lang.Integer NAME_AND_ADDRESS_1
public static final java.lang.Integer NUMBER_2
public static final java.lang.Integer NAME_AND_ADDRESS_2
public static final java.lang.Integer NUMBER_3
public static final java.lang.Integer NAME_AND_ADDRESS_3
public static final java.lang.Integer NUMBER_4
public static final java.lang.Integer NAME_AND_ADDRESS_4
public Field59F()
public Field59F(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field59F(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field59F newInstance(Field59F 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getAccount()
public java.lang.String getComponent2()
public java.lang.Long getComponent2AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent2AsNumber()
getComponent2AsLong()
to get the proper value.getComponent2AsLong()
public java.lang.String getNumber1()
public java.lang.Long getNumber1AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumber1AsNumber()
getComponent2AsLong()
to get the proper value.getNumber1AsLong()
public java.lang.String getComponent3()
public java.lang.String getNameAndAddress1()
public java.lang.String getComponent4()
public java.lang.Long getComponent4AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent4AsNumber()
getComponent4AsLong()
to get the proper value.getComponent4AsLong()
public java.lang.String getNumber2()
public java.lang.Long getNumber2AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumber2AsNumber()
getComponent4AsLong()
to get the proper value.getNumber2AsLong()
public java.lang.String getComponent5()
public java.lang.String getNameAndAddress2()
public java.lang.String getComponent6()
public java.lang.Long getComponent6AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent6AsNumber()
getComponent6AsLong()
to get the proper value.getComponent6AsLong()
public java.lang.String getNumber3()
public java.lang.Long getNumber3AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumber3AsNumber()
getComponent6AsLong()
to get the proper value.getNumber3AsLong()
public java.lang.String getComponent7()
public java.lang.String getNameAndAddress3()
public java.lang.String getComponent8()
public java.lang.Long getComponent8AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent8AsNumber()
getComponent8AsLong()
to get the proper value.getComponent8AsLong()
public java.lang.String getNumber4()
public java.lang.Long getNumber4AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumber4AsNumber()
getComponent8AsLong()
to get the proper value.getNumber4AsLong()
public java.lang.String getComponent9()
public java.lang.String getNameAndAddress4()
public Field59F setComponent1(java.lang.String component1)
component1
- the Account to setpublic Field59F setAccount(java.lang.String component1)
component1
- the Account to setpublic Field59F setComponent2(java.lang.String component2)
component2
- the Number 1 to setpublic Field59F setComponent2(java.lang.Long component2)
component2
- the Long with the Number 1 content to setsetComponent2(String)
public Field59F setComponent2(java.lang.Number component2)
component2
- the Number with the Number 1 content to setsetNumber1(java.lang.Long)
public Field59F setNumber1(java.lang.String component2)
component2
- the Number 1 to setpublic Field59F setNumber1(java.lang.Long component2)
component2
- Long with the Number 1 content to setsetComponent2(java.lang.Long)
public Field59F setNumber1(java.lang.Number component2)
component2
- the Number with the Number 1 content to setsetNumber1(java.lang.Long)
public Field59F setComponent3(java.lang.String component3)
component3
- the Name And Address 1 to setpublic Field59F setNameAndAddress1(java.lang.String component3)
component3
- the Name And Address 1 to setpublic Field59F setComponent4(java.lang.String component4)
component4
- the Number 2 to setpublic Field59F setComponent4(java.lang.Long component4)
component4
- the Long with the Number 2 content to setsetComponent4(String)
public Field59F setComponent4(java.lang.Number component4)
component4
- the Number with the Number 2 content to setsetNumber2(java.lang.Long)
public Field59F setNumber2(java.lang.String component4)
component4
- the Number 2 to setpublic Field59F setNumber2(java.lang.Long component4)
component4
- Long with the Number 2 content to setsetComponent4(java.lang.Long)
public Field59F setNumber2(java.lang.Number component4)
component4
- the Number with the Number 2 content to setsetNumber2(java.lang.Long)
public Field59F setComponent5(java.lang.String component5)
component5
- the Name And Address 2 to setpublic Field59F setNameAndAddress2(java.lang.String component5)
component5
- the Name And Address 2 to setpublic Field59F setComponent6(java.lang.String component6)
component6
- the Number 3 to setpublic Field59F setComponent6(java.lang.Long component6)
component6
- the Long with the Number 3 content to setsetComponent6(String)
public Field59F setComponent6(java.lang.Number component6)
component6
- the Number with the Number 3 content to setsetNumber3(java.lang.Long)
public Field59F setNumber3(java.lang.String component6)
component6
- the Number 3 to setpublic Field59F setNumber3(java.lang.Long component6)
component6
- Long with the Number 3 content to setsetComponent6(java.lang.Long)
public Field59F setNumber3(java.lang.Number component6)
component6
- the Number with the Number 3 content to setsetNumber3(java.lang.Long)
public Field59F setComponent7(java.lang.String component7)
component7
- the Name And Address 3 to setpublic Field59F setNameAndAddress3(java.lang.String component7)
component7
- the Name And Address 3 to setpublic Field59F setComponent8(java.lang.String component8)
component8
- the Number 4 to setpublic Field59F setComponent8(java.lang.Long component8)
component8
- the Long with the Number 4 content to setsetComponent8(String)
public Field59F setComponent8(java.lang.Number component8)
component8
- the Number with the Number 4 content to setsetNumber4(java.lang.Long)
public Field59F setNumber4(java.lang.String component8)
component8
- the Number 4 to setpublic Field59F setNumber4(java.lang.Long component8)
component8
- Long with the Number 4 content to setsetComponent8(java.lang.Long)
public Field59F setNumber4(java.lang.Number component8)
component8
- the Number with the Number 4 content to setsetNumber4(java.lang.Long)
public Field59F setComponent9(java.lang.String component9)
component9
- the Name And Address 4 to setpublic Field59F setNameAndAddress4(java.lang.String component9)
component9
- the Name And Address 4 to setpublic java.lang.String getName()
public static Field59F get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field59F get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field59F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field59F> 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 Field59F fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)
public java.util.List<java.lang.String> detailsByNumber(int lineIdentifier)
lineIdentifier
- a line number in the range of 1 to 3public boolean contains(int lineIdentifier)
lineIdentifier
- a line number in the range of 1 to 3