@Generated public class Field54B extends OptionBPartyField implements java.io.Serializable, MultiLineField
Model and parser for field 54B of a SWIFT MT message.
Subfields (components) Data types
StringStringStringStructure definition
[[/<DC>][/34x]$][35x](****)[[/c][/S]$][S]SSSThis class complies with standard release SRU2021
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
F_54B
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 54B.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
ACCOUNT, COMPONENTS_PATTERN, DC_MARK, LOCATION, PARSER_PATTERN, TYPES_PATTERNcomponents| Constructor and Description |
|---|
Field54B()
Default constructor.
|
Field54B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field54B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
| Modifier and Type | Method and Description |
|---|---|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field54B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field54B object.
|
static Field54B |
get(SwiftMessage msg)
Gets the first instance of Field54B in the given message.
|
static Field54B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field54B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field54B in the given message
an empty list is returned if none found.
|
static java.util.List<Field54B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field54B from the given block
an empty list is returned if none found.
|
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 |
getValueDisplay()
Human readable value of the field
|
static Field54B |
newInstance(Field54B source)
Copy constructor.
|
Field54B |
setAccount(java.lang.String component2)
Set the Account (component 2).
|
Field54B |
setComponent1(java.lang.String component1)
Set the component 1 (D/C Mark).
|
Field54B |
setComponent2(java.lang.String component2)
Set the component 2 (Account).
|
Field54B |
setComponent3(java.lang.String component3)
Set the component 3 (Location).
|
Field54B |
setDCMark(java.lang.String component1)
Set the D/C Mark (component 1).
|
Field54B |
setLocation(java.lang.String component3)
Set the Location (component 3).
|
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 validator pattern.
|
componentsPattern, componentsSize, getAccount, getComponent1, getComponent2, getComponent3, getComponentLabels, getComponentMap, getDCMark, getLocation, getPartyIdentifier, getValue, getValueDisplay, isGeneric, isOptional, parse, parserPattern, setPartyIdentifier, typesPatternappend, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_54B
public Field54B()
public Field54B(java.lang.String value)
value - complete field value including separators and CRLFpublic Field54B(Tag tag)
OptionBPartyField.parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic static Field54B newInstance(Field54B source)
source - a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic final java.lang.String validatorPattern()
validatorPattern in class OptionBPartyFieldpublic Field54B setComponent1(java.lang.String component1)
component1 - the D/C Mark to setpublic Field54B setDCMark(java.lang.String component1)
component1 - the D/C Mark to setpublic Field54B setComponent2(java.lang.String component2)
component2 - the Account to setpublic Field54B setAccount(java.lang.String component2)
component2 - the Account to setpublic Field54B setComponent3(java.lang.String component3)
component3 - the Location to setpublic Field54B setLocation(java.lang.String component3)
component3 - the Location to setpublic java.lang.String getName()
getName in class OptionBPartyFieldpublic static Field54B get(SwiftTagListBlock block)
block - may be null or emptypublic static Field54B get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field54B> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field54B> 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 MultiLineFieldline - 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 MultiLineFieldline - 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 MultiLineFieldMultiLineField.getLines()public java.util.List<java.lang.String> getLines(int offset)
getLines in interface MultiLineFieldoffset - 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 MultiLineFieldstart - 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 MultiLineFieldstart - 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 Field54B fromJson(java.lang.String json)
json - JSON structure including tuples with label and value for all field componentsField.fromJson(String)public java.lang.String getValueDisplay()
getValueDisplay in class FieldField.getValueDisplay(Locale)