@Generated public class Field56D extends Field implements java.io.Serializable, MultiLineField
String
String
String
String
String
String
[[/<DC>][/34x]$]35x[$35x]0-3
[[/c][/S]$]S[$S]0-3
SSSSSS
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACCOUNT
Component number for the Account subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DC_MARK
Component number for the D/C Mark subfield
|
static java.lang.String |
F_56D
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 56D
|
static java.lang.Integer |
NAME_AND_ADDRESS
Component number for the Name And Address subfield
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field56D()
Default constructor.
|
Field56D(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field56D(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()
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 Field56D |
get(SwiftMessage msg)
Get the first instance of Field56D in the given message.
|
static Field56D |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
java.lang.String |
getAccount()
Get the Account (component2) removing its starting slashes if any.
|
static java.util.List<Field56D> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field56D in the given message
an empty list is returned if none found.
|
static java.util.List<Field56D> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field56D from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Get the component3
|
java.lang.String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent4()
Get the component4
|
java.lang.String |
getComponent4AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent5()
Get the component5
|
java.lang.String |
getComponent5AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent6()
Get the component6
|
java.lang.String |
getComponent6AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
java.lang.String |
getDCMark()
Get the D/C Mark (component1).
|
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 |
getNameAndAddress()
Get the Name And Address as a concatenation of component3 to component6.
|
java.lang.String |
getNameAndAddressLine1()
Get the Name And Address (component3).
|
java.lang.String |
getNameAndAddressLine2()
Get the Name And Address (component4).
|
java.lang.String |
getNameAndAddressLine3()
Get the Name And Address (component5).
|
java.lang.String |
getNameAndAddressLine4()
Get the Name And Address (component6).
|
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 Field56D |
newInstance(Field56D source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern() |
Field56D |
setAccount(java.lang.String component2)
Set the Account (component2).
|
Field56D |
setComponent1(java.lang.String component1)
Set the component1.
|
Field56D |
setComponent2(java.lang.String component2)
Set the component2.
|
Field56D |
setComponent3(java.lang.String component3)
Set the component3.
|
Field56D |
setComponent4(java.lang.String component4)
Set the component4.
|
Field56D |
setComponent5(java.lang.String component5)
Set the component5.
|
Field56D |
setComponent6(java.lang.String component6)
Set the component6.
|
Field56D |
setDCMark(java.lang.String component1)
Set the D/C Mark (component1).
|
Field56D |
setNameAndAddress(java.lang.String value)
Set the Name And Address splitting the parameter lines into components 3 to 6.
|
Field56D |
setNameAndAddressLine1(java.lang.String component3)
Set the Name And Address (component3).
|
Field56D |
setNameAndAddressLine2(java.lang.String component4)
Set the Name And Address (component4).
|
Field56D |
setNameAndAddressLine3(java.lang.String component5)
Set the Name And Address (component5).
|
Field56D |
setNameAndAddressLine4(java.lang.String component6)
Set the Name And Address (component6).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.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, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_56D
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DC_MARK
public static final java.lang.Integer ACCOUNT
public static final java.lang.Integer NAME_AND_ADDRESS
public Field56D()
public Field56D(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field56D(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field56D newInstance(Field56D source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getDCMark()
public Field56D setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field56D setDCMark(java.lang.String component1)
component1
- the D/C Mark to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getAccount()
public Field56D setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field56D setAccount(java.lang.String component2)
component2
- the Account to setpublic java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent3AsString()
Field.getComponent(int)
insteadpublic java.lang.String getNameAndAddressLine1()
public java.lang.String getNameAndAddressLine2()
public java.lang.String getNameAndAddressLine3()
public java.lang.String getNameAndAddressLine4()
public java.lang.String getNameAndAddress()
public Field56D setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field56D setNameAndAddressLine1(java.lang.String component3)
component3
- the Name And Address to setpublic Field56D setNameAndAddressLine2(java.lang.String component4)
component4
- the Name And Address to setpublic Field56D setNameAndAddressLine3(java.lang.String component5)
component5
- the Name And Address to setpublic Field56D setNameAndAddressLine4(java.lang.String component6)
component6
- the Name And Address to setpublic Field56D setNameAndAddress(java.lang.String value)
value
- the Name And Address to set, may contain line ends and each line will be set to its correspondent component attributepublic java.lang.String getComponent4()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent4AsString()
Field.getComponent(int)
insteadpublic Field56D setComponent4(java.lang.String component4)
component4
- the component4 to setpublic java.lang.String getComponent5()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent5AsString()
Field.getComponent(int)
insteadpublic Field56D setComponent5(java.lang.String component5)
component5
- the component5 to setpublic java.lang.String getComponent6()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent6AsString()
Field.getComponent(int)
insteadpublic Field56D setComponent6(java.lang.String component6)
component6
- the component6 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 java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field56D get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field56D get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field56D> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field56D> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public 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 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 fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)