@Generated public class Field72 extends StructuredNarrativeField implements java.io.Serializable, NarrativeContainer, MultiLineField
Model and parser for field 72 of a SWIFT MT message.
Subfields (components) Data types
String
Structure definition
CUSTOM
S
S
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
F_72
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 72
|
static java.lang.Integer |
NARRATIVE
Deprecated.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
COMPONENTS_PATTERN, PARSER_PATTERN
components
Constructor and Description |
---|
Field72()
Default constructor.
|
Field72(Narrative narrative)
Creates a new field from a Narrative instance.
|
Field72(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field72(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
Shorthand for
new Tag(NAME, "") |
static Field72 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field72 object.
|
static Field72 |
get(SwiftMessage msg)
Gets the first instance of Field72 in the given message.
|
static Field72 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field72> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field72 in the given message
an empty list is returned if none found.
|
static java.util.List<Field72> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field72 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent2()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getComponent3()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getComponent4()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getComponent5()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getComponent6()
Deprecated.
use getLine(int) or narrative() instead
|
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 |
getNarrative()
Deprecated.
use getValue() instead
|
java.lang.String |
getNarrativeLine1()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getNarrativeLine2()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getNarrativeLine3()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getNarrativeLine4()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getNarrativeLine5()
Deprecated.
use getLine(int) or narrative() instead
|
java.lang.String |
getNarrativeLine6()
Deprecated.
use getLine(int) or narrative() instead
|
static Field72 |
newInstance(Field72 source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
Field72 |
setComponent1(java.lang.String component1)
Set the component1 (Narrative).
|
Field72 |
setComponent2(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setComponent3(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setComponent4(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setComponent5(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setComponent6(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrative(java.lang.String component1)
Set the Narrative (component1).
|
Field72 |
setNarrativeLine1(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrativeLine2(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrativeLine3(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrativeLine4(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrativeLine5(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
Field72 |
setNarrativeLine6(java.lang.String component)
Deprecated.
this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead
|
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
|
appendLine, componentsPattern, componentsSize, getComponent1, getComponentLabels, getComponentMap, getValue, getValueDisplay, isGeneric, isOptional, narrative, parse, parserPattern, setNarrative
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
appendLine, narrative, setNarrative
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_72
@Deprecated @ProwideDeprecated(phase2=SRU2021) public static final java.lang.Integer NARRATIVE
public Field72()
public Field72(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field72(Tag tag)
StructuredNarrativeField.parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic Field72(Narrative narrative)
narrative
- a not-null narrative to use as field valueNarrative.builder(int)
public static Field72 newInstance(Field72 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 final java.lang.String validatorPattern()
validatorPattern
in class StructuredNarrativeField
public Field72 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field72 setNarrative(java.lang.String component1)
component1
- the Narrative to setpublic java.lang.String getName()
getName
in class StructuredNarrativeField
public static Field72 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field72 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field72> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field72> 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 Field72 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrative()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine1()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine1(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setComponent2(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine2()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine2(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setComponent3(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine3()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine3(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getComponent4()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setComponent4(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine4()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine4(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getComponent5()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setComponent5(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine5()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine5(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getComponent6()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setComponent6(java.lang.String component)
@Deprecated @ProwideDeprecated(phase2=SRU2021) public java.lang.String getNarrativeLine6()
@Deprecated @ProwideDeprecated(phase2=SRU2021) public Field72 setNarrativeLine6(java.lang.String component)