Class Field59F
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field59F
-
- All Implemented Interfaces:
JsonSerializable
,MultiLineField
,PatternContainer
,java.io.Serializable
@Generated public class Field59F extends Field implements java.io.Serializable, MultiLineField
SWIFT MT Field 59F.Model and parser for field 59F of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Account:
String
- Component 2: Number1:
Long
- Component 3: NameAndAddress1:
String
- Component 4: Number2:
Long
- Component 5: NameAndAddress2:
String
- Component 6: Number3:
Long
- Component 7: NameAndAddress3:
String
- Component 8: Number4:
Long
- Component 9: NameAndAddress4:
String
Structure definition
- validation pattern:
CUSTOM
- parser pattern:
[/S$]N/S[$N/S$]0-3
- components pattern:
SNSNSNSNS
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
ACCOUNT
Component number for the Account subfield.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
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.UseparserPattern()
method instead.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field59F()
Default constructor.Field59F(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field59F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
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 Longjava.lang.Number
getComponent2AsNumber()
Deprecated.use #getComponent2AsLong() insteadjava.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 Longjava.lang.Number
getComponent4AsNumber()
Deprecated.use #getComponent4AsLong() insteadjava.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 Longjava.lang.Number
getComponent6AsNumber()
Deprecated.use #getComponent6AsLong() insteadjava.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 Longjava.lang.Number
getComponent8AsNumber()
Deprecated.use #getComponent8AsLong() insteadjava.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 Longjava.lang.Number
getNumber1AsNumber()
Deprecated.use #getNumber1AsLong() insteadjava.lang.String
getNumber2()
Gets the Number 2 (component 4).java.lang.Long
getNumber2AsLong()
Get the Number 2 (component 4) as Longjava.lang.Number
getNumber2AsNumber()
Deprecated.use #getNumber2AsLong() insteadjava.lang.String
getNumber3()
Gets the Number 3 (component 6).java.lang.Long
getNumber3AsLong()
Get the Number 3 (component 6) as Longjava.lang.Number
getNumber3AsNumber()
Deprecated.use #getNumber3AsLong() insteadjava.lang.String
getNumber4()
Gets the Number 4 (component 8).java.lang.Long
getNumber4AsLong()
Get the Number 4 (component 8) as Longjava.lang.Number
getNumber4AsNumber()
Deprecated.use #getNumber4AsLong() insteadjava.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-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
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
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 59F.- See Also:
- Constant Field Values
-
F_59F
public static final java.lang.String F_59F
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
ACCOUNT
public static final java.lang.Integer ACCOUNT
Component number for the Account subfield.
-
NUMBER_1
public static final java.lang.Integer NUMBER_1
Component number for the Number 1 subfield.
-
NAME_AND_ADDRESS_1
public static final java.lang.Integer NAME_AND_ADDRESS_1
Component number for the Name And Address 1 subfield.
-
NUMBER_2
public static final java.lang.Integer NUMBER_2
Component number for the Number 2 subfield.
-
NAME_AND_ADDRESS_2
public static final java.lang.Integer NAME_AND_ADDRESS_2
Component number for the Name And Address 2 subfield.
-
NUMBER_3
public static final java.lang.Integer NUMBER_3
Component number for the Number 3 subfield.
-
NAME_AND_ADDRESS_3
public static final java.lang.Integer NAME_AND_ADDRESS_3
Component number for the Name And Address 3 subfield.
-
NUMBER_4
public static final java.lang.Integer NUMBER_4
Component number for the Number 4 subfield.
-
NAME_AND_ADDRESS_4
public static final java.lang.Integer NAME_AND_ADDRESS_4
Component number for the Name And Address 4 subfield.
-
-
Constructor Detail
-
Field59F
public Field59F()
Default constructor. Creates a new field setting all components to null.
-
Field59F
public Field59F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field59F
public Field59F(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field59F newInstance(Field59F source)
Copy constructor. Initializes the components list with a deep copy of the source components list.- Parameters:
source
- a field instance to copy- Since:
- 7.7
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew Tag(NAME, value)
- Since:
- 7.5
- See Also:
NAME
-
emptyTag
public static Tag emptyTag()
Create a Tag with this field name and an empty string as value. Shorthand fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
isOptional
public 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.- Specified by:
isOptional
in classField
- Parameters:
component
- component number, first component of a field is referenced as 1- Returns:
- true if the component is optional for this field, false otherwise
-
isGeneric
public boolean isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
-
componentsSize
public 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.- Specified by:
componentsSize
in classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Account).- Returns:
- the component 1
-
getAccount
public java.lang.String getAccount()
Gets the Account (component 1) removing its starting slashes if any.- Returns:
- the Account from component 1
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Number 1).- Returns:
- the component 2
-
getComponent2AsLong
public java.lang.Long getComponent2AsLong()
Get the component 2 as Long- Returns:
- the component 2 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent2AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent2AsNumber()
Deprecated.use #getComponent2AsLong() instead
-
getNumber1
public java.lang.String getNumber1()
Gets the Number 1 (component 2).- Returns:
- the Number 1 from component 2
-
getNumber1AsLong
public java.lang.Long getNumber1AsLong()
Get the Number 1 (component 2) as Long- Returns:
- the Number 1 from component 2 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumber1AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumber1AsNumber()
Deprecated.use #getNumber1AsLong() instead
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Name And Address 1).- Returns:
- the component 3
-
getNameAndAddress1
public java.lang.String getNameAndAddress1()
Gets the Name And Address 1 (component 3).- Returns:
- the Name And Address 1 from component 3
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (Number 2).- Returns:
- the component 4
-
getComponent4AsLong
public java.lang.Long getComponent4AsLong()
Get the component 4 as Long- Returns:
- the component 4 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent4AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent4AsNumber()
Deprecated.use #getComponent4AsLong() instead
-
getNumber2
public java.lang.String getNumber2()
Gets the Number 2 (component 4).- Returns:
- the Number 2 from component 4
-
getNumber2AsLong
public java.lang.Long getNumber2AsLong()
Get the Number 2 (component 4) as Long- Returns:
- the Number 2 from component 4 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumber2AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumber2AsNumber()
Deprecated.use #getNumber2AsLong() instead
-
getComponent5
public java.lang.String getComponent5()
Gets the component 5 (Name And Address 2).- Returns:
- the component 5
-
getNameAndAddress2
public java.lang.String getNameAndAddress2()
Gets the Name And Address 2 (component 5).- Returns:
- the Name And Address 2 from component 5
-
getComponent6
public java.lang.String getComponent6()
Gets the component 6 (Number 3).- Returns:
- the component 6
-
getComponent6AsLong
public java.lang.Long getComponent6AsLong()
Get the component 6 as Long- Returns:
- the component 6 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent6AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent6AsNumber()
Deprecated.use #getComponent6AsLong() instead
-
getNumber3
public java.lang.String getNumber3()
Gets the Number 3 (component 6).- Returns:
- the Number 3 from component 6
-
getNumber3AsLong
public java.lang.Long getNumber3AsLong()
Get the Number 3 (component 6) as Long- Returns:
- the Number 3 from component 6 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumber3AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumber3AsNumber()
Deprecated.use #getNumber3AsLong() instead
-
getComponent7
public java.lang.String getComponent7()
Gets the component 7 (Name And Address 3).- Returns:
- the component 7
-
getNameAndAddress3
public java.lang.String getNameAndAddress3()
Gets the Name And Address 3 (component 7).- Returns:
- the Name And Address 3 from component 7
-
getComponent8
public java.lang.String getComponent8()
Gets the component 8 (Number 4).- Returns:
- the component 8
-
getComponent8AsLong
public java.lang.Long getComponent8AsLong()
Get the component 8 as Long- Returns:
- the component 8 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent8AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent8AsNumber()
Deprecated.use #getComponent8AsLong() instead
-
getNumber4
public java.lang.String getNumber4()
Gets the Number 4 (component 8).- Returns:
- the Number 4 from component 8
-
getNumber4AsLong
public java.lang.Long getNumber4AsLong()
Get the Number 4 (component 8) as Long- Returns:
- the Number 4 from component 8 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumber4AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumber4AsNumber()
Deprecated.use #getNumber4AsLong() instead
-
getComponent9
public java.lang.String getComponent9()
Gets the component 9 (Name And Address 4).- Returns:
- the component 9
-
getNameAndAddress4
public java.lang.String getNameAndAddress4()
Gets the Name And Address 4 (component 9).- Returns:
- the Name And Address 4 from component 9
-
setComponent1
public Field59F setComponent1(java.lang.String component1)
Set the component 1 (Account).- Parameters:
component1
- the Account to set- Returns:
- the field object to enable build pattern
-
setAccount
public Field59F setAccount(java.lang.String component1)
Set the Account (component 1).- Parameters:
component1
- the Account to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field59F setComponent2(java.lang.String component2)
Set the component 2 (Number 1).- Parameters:
component2
- the Number 1 to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field59F setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.- Parameters:
component2
- the Long with the Number 1 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent2(String)
-
setComponent2
public 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)- Parameters:
component2
- the Number with the Number 1 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber1(java.lang.Long)
-
setNumber1
public Field59F setNumber1(java.lang.String component2)
Set the Number 1 (component 2).- Parameters:
component2
- the Number 1 to set- Returns:
- the field object to enable build pattern
-
setNumber1
public Field59F setNumber1(java.lang.Long component2)
Set the Number 1 (component 2) from a Long object.- Parameters:
component2
- Long with the Number 1 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent2(java.lang.Long)
-
setNumber1
public 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)- Parameters:
component2
- the Number with the Number 1 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber1(java.lang.Long)
-
setComponent3
public Field59F setComponent3(java.lang.String component3)
Set the component 3 (Name And Address 1).- Parameters:
component3
- the Name And Address 1 to set- Returns:
- the field object to enable build pattern
-
setNameAndAddress1
public Field59F setNameAndAddress1(java.lang.String component3)
Set the Name And Address 1 (component 3).- Parameters:
component3
- the Name And Address 1 to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field59F setComponent4(java.lang.String component4)
Set the component 4 (Number 2).- Parameters:
component4
- the Number 2 to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field59F setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent4(String) method.- Parameters:
component4
- the Long with the Number 2 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent4(String)
-
setComponent4
public 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)- Parameters:
component4
- the Number with the Number 2 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber2(java.lang.Long)
-
setNumber2
public Field59F setNumber2(java.lang.String component4)
Set the Number 2 (component 4).- Parameters:
component4
- the Number 2 to set- Returns:
- the field object to enable build pattern
-
setNumber2
public Field59F setNumber2(java.lang.Long component4)
Set the Number 2 (component 4) from a Long object.- Parameters:
component4
- Long with the Number 2 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent4(java.lang.Long)
-
setNumber2
public 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)- Parameters:
component4
- the Number with the Number 2 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber2(java.lang.Long)
-
setComponent5
public Field59F setComponent5(java.lang.String component5)
Set the component 5 (Name And Address 2).- Parameters:
component5
- the Name And Address 2 to set- Returns:
- the field object to enable build pattern
-
setNameAndAddress2
public Field59F setNameAndAddress2(java.lang.String component5)
Set the Name And Address 2 (component 5).- Parameters:
component5
- the Name And Address 2 to set- Returns:
- the field object to enable build pattern
-
setComponent6
public Field59F setComponent6(java.lang.String component6)
Set the component 6 (Number 3).- Parameters:
component6
- the Number 3 to set- Returns:
- the field object to enable build pattern
-
setComponent6
public Field59F setComponent6(java.lang.Long component6)
Set the component6 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent6(String) method.- Parameters:
component6
- the Long with the Number 3 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent6(String)
-
setComponent6
public 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)- Parameters:
component6
- the Number with the Number 3 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber3(java.lang.Long)
-
setNumber3
public Field59F setNumber3(java.lang.String component6)
Set the Number 3 (component 6).- Parameters:
component6
- the Number 3 to set- Returns:
- the field object to enable build pattern
-
setNumber3
public Field59F setNumber3(java.lang.Long component6)
Set the Number 3 (component 6) from a Long object.- Parameters:
component6
- Long with the Number 3 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent6(java.lang.Long)
-
setNumber3
public 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)- Parameters:
component6
- the Number with the Number 3 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber3(java.lang.Long)
-
setComponent7
public Field59F setComponent7(java.lang.String component7)
Set the component 7 (Name And Address 3).- Parameters:
component7
- the Name And Address 3 to set- Returns:
- the field object to enable build pattern
-
setNameAndAddress3
public Field59F setNameAndAddress3(java.lang.String component7)
Set the Name And Address 3 (component 7).- Parameters:
component7
- the Name And Address 3 to set- Returns:
- the field object to enable build pattern
-
setComponent8
public Field59F setComponent8(java.lang.String component8)
Set the component 8 (Number 4).- Parameters:
component8
- the Number 4 to set- Returns:
- the field object to enable build pattern
-
setComponent8
public Field59F setComponent8(java.lang.Long component8)
Set the component8 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent8(String) method.- Parameters:
component8
- the Long with the Number 4 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent8(String)
-
setComponent8
public 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)- Parameters:
component8
- the Number with the Number 4 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber4(java.lang.Long)
-
setNumber4
public Field59F setNumber4(java.lang.String component8)
Set the Number 4 (component 8).- Parameters:
component8
- the Number 4 to set- Returns:
- the field object to enable build pattern
-
setNumber4
public Field59F setNumber4(java.lang.Long component8)
Set the Number 4 (component 8) from a Long object.- Parameters:
component8
- Long with the Number 4 content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent8(java.lang.Long)
-
setNumber4
public 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)- Parameters:
component8
- the Number with the Number 4 content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber4(java.lang.Long)
-
setComponent9
public Field59F setComponent9(java.lang.String component9)
Set the component 9 (Name And Address 4).- Parameters:
component9
- the Name And Address 4 to set- Returns:
- the field object to enable build pattern
-
setNameAndAddress4
public Field59F setNameAndAddress4(java.lang.String component9)
Set the Name And Address 4 (component 9).- Parameters:
component9
- the Name And Address 4 to set- Returns:
- the field object to enable build pattern
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field59F get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.- Parameters:
block
- may be null or empty- Returns:
- null if not found o block is null or empty
-
get
public static Field59F get(SwiftMessage msg)
Gets the first instance of Field59F in the given message.- Parameters:
msg
- may be empty or null- Returns:
- null if not found or msg is empty or null
- See Also:
get(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
msg
- may be empty or null in which case an empty list is returned- See Also:
getAll(SwiftTagListBlock)
-
getAll
public 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.- Parameters:
block
- may be empty or null in which case an empty list is returned
-
getLine
public java.lang.String getLine(int line)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int)
-
getLine
public java.lang.String getLine(int line, int offset)
Returns a specific line from the field's value.- Specified by:
getLine
in interfaceMultiLineField
- Parameters:
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting lines- Returns:
- line content or null if not present or if line number is above the expected
- Since:
- 7.7
- See Also:
MultiLineField.getLine(int, int)
-
getLines
public java.util.List<java.lang.String> getLines()
Returns the field value split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Returns:
- lines content or empty list if field's value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLines()
-
getLines
public java.util.List<java.lang.String> getLines(int offset)
Returns the field value starting at the offset component, split into lines.- Specified by:
getLines
in interfaceMultiLineField
- Parameters:
offset
- an optional component number used as offset when counting lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLines(int)
-
getLinesBetween
public 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.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
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 start- Returns:
- found lines or empty list if value is empty
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int, int )
-
getLinesBetween
public 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.- Specified by:
getLinesBetween
in interfaceMultiLineField
- Parameters:
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 lines- Returns:
- found lines or empty list if lines are not present or the offset is invalid
- Since:
- 7.7
- See Also:
MultiLineField.getLinesBetween(int start, int end, int offset)
-
fromJson
public static Field59F fromJson(java.lang.String json)
This method deserializes the JSON data into a Field59F object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
detailsByNumber
public java.util.List<java.lang.String> detailsByNumber(int lineIdentifier)
Get the details (right part of the line) based on the line identification number. This API is specific for the structured field 59F.- Parameters:
lineIdentifier
- a line number in the range of 1 to 3- Returns:
- the details for the found lines or empty list if non is found or the line number is incorrect
- Since:
- 7.10.4
-
contains
public boolean contains(int lineIdentifier)
Check if the line identified by a given number is present. This API is specific for the structured field 59F.- Parameters:
lineIdentifier
- a line number in the range of 1 to 3- Returns:
- true if the structured content includes the line identified by the given number
- Since:
- 7.10.4
-
-