@Generated public class Field59F extends Field implements Serializable, MultiLineField
String
Number
String
Number
String
Number
String
Number
String
CUSTOM
[/S$]N/S[$N/S$]0-3
SNSNSNSNS
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static Integer |
ACCOUNT
Component number for the Account subfield
|
static String |
COMPONENTS_PATTERN |
static String |
F_59F
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 59F
|
static Integer |
NAME_AND_ADDRESS_1
Component number for the Name And Address 1 subfield
|
static Integer |
NAME_AND_ADDRESS_2
Component number for the Name And Address 2 subfield
|
static Integer |
NAME_AND_ADDRESS_3
Component number for the Name And Address 3 subfield
|
static Integer |
NAME_AND_ADDRESS_4
Component number for the Name And Address 4 subfield
|
static Integer |
NUMBER_1
Component number for the Number 1 subfield
|
static Integer |
NUMBER_2
Component number for the Number 2 subfield
|
static Integer |
NUMBER_3
Component number for the Number 3 subfield
|
static Integer |
NUMBER_4
Component number for the Number 4 subfield
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field59F()
Default constructor.
|
Field59F(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 |
---|---|
String |
componentsPattern()
Returns the field's components pattern
|
int |
componentsSize()
Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field59F |
get(SwiftMessage msg)
Get the first instance of Field59F in the given message.
|
static Field59F |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
String |
getAccount()
Get the Account (component1) removing its starting slashes if any.
|
static List<Field59F> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field59F in the given message
an empty list is returned if none found.
|
static List<Field59F> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field59F from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent2()
Get the component2
|
Number |
getComponent2AsNumber()
Get the component2 as Number
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent6()
Get the component6
|
Number |
getComponent6AsNumber()
Get the component6 as Number
|
String |
getComponent7()
Get the component7
|
String |
getComponent7AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent8()
Get the component8
|
Number |
getComponent8AsNumber()
Get the component8 as Number
|
String |
getComponent9()
Get the component9
|
String |
getComponent9AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getLine(int line)
Returns a specific line from the field's value.
|
String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
List<String> |
getLines()
Returns the field value split into lines.
|
List<String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
List<String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
List<String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getNameAndAddress1()
Get the Name And Address 1 (component3).
|
String |
getNameAndAddress2()
Get the Name And Address 2 (component5).
|
String |
getNameAndAddress3()
Get the Name And Address 3 (component7).
|
String |
getNameAndAddress4()
Get the Name And Address 4 (component9).
|
String |
getNumber1()
Get the Number 1 (component2).
|
Number |
getNumber1AsNumber()
Get the Number 1 (component2) as Number
|
String |
getNumber2()
Get the Number 2 (component4).
|
Number |
getNumber2AsNumber()
Get the Number 2 (component4) as Number
|
String |
getNumber3()
Get the Number 3 (component6).
|
Number |
getNumber3AsNumber()
Get the Number 3 (component6) as Number
|
String |
getNumber4()
Get the Number 4 (component8).
|
Number |
getNumber4AsNumber()
Get the Number 4 (component8) as Number
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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.
Initializes the components list with a deep copy of the source components list. |
void |
parse(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field59F |
setAccount(String component1)
Set the Account (component1).
|
Field59F |
setComponent1(String component1)
Set the component1.
|
Field59F |
setComponent2(Number component2)
Set the component2 from a Number object.
|
Field59F |
setComponent2(String component2)
Set the component2.
|
Field59F |
setComponent3(String component3)
Set the component3.
|
Field59F |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field59F |
setComponent4(String component4)
Set the component4.
|
Field59F |
setComponent5(String component5)
Set the component5.
|
Field59F |
setComponent6(Number component6)
Set the component6 from a Number object.
|
Field59F |
setComponent6(String component6)
Set the component6.
|
Field59F |
setComponent7(String component7)
Set the component7.
|
Field59F |
setComponent8(Number component8)
Set the component8 from a Number object.
|
Field59F |
setComponent8(String component8)
Set the component8.
|
Field59F |
setComponent9(String component9)
Set the component9.
|
Field59F |
setNameAndAddress1(String component3)
Set the Name And Address 1 (component3).
|
Field59F |
setNameAndAddress2(String component5)
Set the Name And Address 2 (component5).
|
Field59F |
setNameAndAddress3(String component7)
Set the Name And Address 3 (component7).
|
Field59F |
setNameAndAddress4(String component9)
Set the Name And Address 4 (component9).
|
Field59F |
setNumber1(Number component2)
Set the Number 1 (component2) from a Number object.
|
Field59F |
setNumber1(String component2)
Set the Number 1 (component2).
|
Field59F |
setNumber2(Number component4)
Set the Number 2 (component4) from a Number object.
|
Field59F |
setNumber2(String component4)
Set the Number 2 (component4).
|
Field59F |
setNumber3(Number component6)
Set the Number 3 (component6) from a Number object.
|
Field59F |
setNumber3(String component6)
Set the Number 3 (component6).
|
Field59F |
setNumber4(Number component8)
Set the Number 4 (component8) from a Number object.
|
Field59F |
setNumber4(String component8)
Set the Number 4 (component8).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_59F
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer ACCOUNT
public static final Integer NUMBER_1
public static final Integer NAME_AND_ADDRESS_1
public static final Integer NUMBER_2
public static final Integer NAME_AND_ADDRESS_2
public static final Integer NUMBER_3
public static final Integer NAME_AND_ADDRESS_3
public static final Integer NUMBER_4
public static final Integer NAME_AND_ADDRESS_4
public Field59F()
public Field59F(String value)
value
- complete field value including separators and CRLFpublic Field59F(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field59F newInstance(Field59F source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent1AsString()
Field.getComponent(int)
insteadpublic String getAccount()
public Field59F setComponent1(String component1)
component1
- the component1 to setpublic Field59F setAccount(String component1)
component1
- the Account to setpublic String getComponent2()
public Number getComponent2AsNumber()
null
if cannot be convertedpublic String getNumber1()
public Number getNumber1AsNumber()
null
if cannot be convertedpublic Field59F setComponent2(String component2)
component2
- the component2 to setpublic Field59F setComponent2(Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field59F setNumber1(String component2)
component2
- the Number 1 to setpublic Field59F setNumber1(Number component2)
component2
- Number with the Number 1 content to setsetComponent2(java.lang.Number)
public String getComponent3()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent3AsString()
Field.getComponent(int)
insteadpublic String getNameAndAddress1()
public Field59F setComponent3(String component3)
component3
- the component3 to setpublic Field59F setNameAndAddress1(String component3)
component3
- the Name And Address 1 to setpublic String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getNumber2()
public Number getNumber2AsNumber()
null
if cannot be convertedpublic Field59F setComponent4(String component4)
component4
- the component4 to setpublic Field59F setComponent4(Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field59F setNumber2(String component4)
component4
- the Number 2 to setpublic Field59F setNumber2(Number component4)
component4
- Number with the Number 2 content to setsetComponent4(java.lang.Number)
public String getComponent5()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent5AsString()
Field.getComponent(int)
insteadpublic String getNameAndAddress2()
public Field59F setComponent5(String component5)
component5
- the component5 to setpublic Field59F setNameAndAddress2(String component5)
component5
- the Name And Address 2 to setpublic String getComponent6()
public Number getComponent6AsNumber()
null
if cannot be convertedpublic String getNumber3()
public Number getNumber3AsNumber()
null
if cannot be convertedpublic Field59F setComponent6(String component6)
component6
- the component6 to setpublic Field59F setComponent6(Number component6)
component6
- the Number with the component6 content to setsetComponent6(String)
public Field59F setNumber3(String component6)
component6
- the Number 3 to setpublic Field59F setNumber3(Number component6)
component6
- Number with the Number 3 content to setsetComponent6(java.lang.Number)
public String getComponent7()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent7AsString()
Field.getComponent(int)
insteadpublic String getNameAndAddress3()
public Field59F setComponent7(String component7)
component7
- the component7 to setpublic Field59F setNameAndAddress3(String component7)
component7
- the Name And Address 3 to setpublic String getComponent8()
public Number getComponent8AsNumber()
null
if cannot be convertedpublic String getNumber4()
public Number getNumber4AsNumber()
null
if cannot be convertedpublic Field59F setComponent8(String component8)
component8
- the component8 to setpublic Field59F setComponent8(Number component8)
component8
- the Number with the component8 content to setsetComponent8(String)
public Field59F setNumber4(String component8)
component8
- the Number 4 to setpublic Field59F setNumber4(Number component8)
component8
- Number with the Number 4 content to setsetComponent8(java.lang.Number)
public String getComponent9()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent9AsString()
Field.getComponent(int)
insteadpublic String getNameAndAddress4()
public Field59F setComponent9(String component9)
component9
- the component9 to setpublic Field59F setNameAndAddress4(String component9)
component9
- the Name And Address 4 to setpublic boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
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 List<Field59F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field59F> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public 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 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 List<String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public List<String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public List<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 List<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 String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)