@Generated public class Field56B extends Field implements java.io.Serializable, MultiLineField
Model and parser for field 56B of a SWIFT MT message.
Subfields (components) Data types
String
String
String
Structure definition
[[/<DC>][/34x]$]35x
[[/c][/S]$]S
SSS
This class complies with standard release SRU2019
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_56B
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
LOCATION
Component number for the Location subfield
|
static java.lang.String |
NAME
Constant with the field name 56B
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
Constructor and Description |
---|
Field56B()
Default constructor.
|
Field56B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field56B(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 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 Field56B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field56B object.
|
static Field56B |
get(SwiftMessage msg)
Gets the first instance of Field56B in the given message.
|
static Field56B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
java.lang.String |
getAccount()
Gets the Account (component2) removing its starting slashes if any.
|
static java.util.List<Field56B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field56B in the given message
an empty list is returned if none found.
|
static java.util.List<Field56B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field56B from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component1 (D/C Mark).
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2 (Account).
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Gets the component3 (Location).
|
java.lang.String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getDCMark()
Gets 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 |
getLocation()
Gets the Location (component3).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
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 Field56B |
newInstance(Field56B 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()
Returns the field parser pattern
|
Field56B |
setAccount(java.lang.String component2)
Set the Account (component2).
|
Field56B |
setComponent1(java.lang.String component1)
Set the component1 (D/C Mark).
|
Field56B |
setComponent2(java.lang.String component2)
Set the component2 (Account).
|
Field56B |
setComponent3(java.lang.String component3)
Set the component3 (Location).
|
Field56B |
setDCMark(java.lang.String component1)
Set the D/C Mark (component1).
|
Field56B |
setLocation(java.lang.String component3)
Set the Location (component3).
|
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
|
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_56B
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 LOCATION
public Field56B()
public Field56B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field56B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field56B newInstance(Field56B 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 fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final 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.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getDCMark()
public java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getAccount()
public java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent3AsString()
Field.getComponent(int)
insteadpublic java.lang.String getLocation()
public Field56B setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field56B setDCMark(java.lang.String component1)
component1
- the D/C Mark to setpublic Field56B setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field56B setAccount(java.lang.String component2)
component2
- the Account to setpublic Field56B setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field56B setLocation(java.lang.String component3)
component3
- the Location to setpublic java.lang.String getName()
public static Field56B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field56B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field56B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field56B> 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 Field56B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)