Class Field54B
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.OptionBPartyField
-
- com.prowidesoftware.swift.model.field.Field54B
-
- All Implemented Interfaces:
JsonSerializable
,MultiLineField
,PartyIdentifier
,PatternContainer
,java.io.Serializable
@Generated public class Field54B extends OptionBPartyField implements java.io.Serializable, MultiLineField
SWIFT MT Field 54B.Model and parser for field 54B of a SWIFT MT message.
Subfields (components) Data types
- Component 1: DCMark:
String
- Component 2: Account:
String
- Component 3: Location:
String
Structure definition
- validation pattern:
[[/<DC>][/34x]$][35x](****)
- parser pattern:
[[/c][/S]$][S]
- components pattern:
SSS
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field 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.-
Fields inherited from class com.prowidesoftware.swift.model.field.OptionBPartyField
ACCOUNT, COMPONENTS_PATTERN, DC_MARK, LOCATION, PARSER_PATTERN, TYPES_PATTERN
-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field54B()
Default constructor.Field54B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field54B(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 Modifier and Type Method 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 fieldstatic 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.-
Methods inherited from class com.prowidesoftware.swift.model.field.OptionBPartyField
componentsPattern, componentsSize, getAccount, getComponent1, getComponent2, getComponent3, getComponentLabels, getComponentMap, getDCMark, getLabelMap, getLocation, getPartyIdentifier, getValue, getValueDisplay, isGeneric, isOptional, parse, parserPattern, setPartyIdentifier, typesPattern
-
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, 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 54B.- See Also:
- Constant Field Values
-
F_54B
public static final java.lang.String F_54B
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Field54B
public Field54B()
Default constructor. Creates a new field setting all components to null.
-
Field54B
public Field54B(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
-
Field54B
public Field54B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withOptionBPartyField.parse(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 Field54B newInstance(Field54B 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
-
validatorPattern
public final java.lang.String validatorPattern()
Returns the field validator pattern.- Specified by:
validatorPattern
in classOptionBPartyField
-
setComponent1
public Field54B setComponent1(java.lang.String component1)
Set the component 1 (D/C Mark).- Parameters:
component1
- the D/C Mark to set- Returns:
- the field object to enable build pattern
-
setDCMark
public Field54B setDCMark(java.lang.String component1)
Set the D/C Mark (component 1).- Parameters:
component1
- the D/C Mark to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field54B setComponent2(java.lang.String component2)
Set the component 2 (Account).- Parameters:
component2
- the Account to set- Returns:
- the field object to enable build pattern
-
setAccount
public Field54B setAccount(java.lang.String component2)
Set the Account (component 2).- Parameters:
component2
- the Account to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field54B setComponent3(java.lang.String component3)
Set the component 3 (Location).- Parameters:
component3
- the Location to set- Returns:
- the field object to enable build pattern
-
setLocation
public Field54B setLocation(java.lang.String component3)
Set the Location (component 3).- Parameters:
component3
- the Location 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).- Specified by:
getName
in classOptionBPartyField
- Returns:
- the static value of Field54B.NAME
-
get
public static Field54B 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 Field54B get(SwiftMessage msg)
Gets the first instance of Field54B 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<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.- 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<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.- 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 Field54B fromJson(java.lang.String json)
This method deserializes the JSON data into a Field54B 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)
-
getValueDisplay
public java.lang.String getValueDisplay()
Human readable value of the field- Overrides:
getValueDisplay
in classField
- Returns:
- s
- See Also:
Field.getValueDisplay(Locale)
-
-