@Generated public class Field70E extends Field implements java.io.Serializable, GenericField, MultiLineField
Model and parser for field 70E of a SWIFT MT message.
Subfields (components) Data types
String
String
String
String
String
String
String
String
String
String
String
Structure definition
:4!c//35x[$35x]0-9
:S//S[$S]0-9
SSSSSSSSSSS
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.String |
F_70E
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 70E
|
static java.lang.Integer |
NARRATIVE
Component number for the Narrative subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field70E()
Default constructor.
|
Field70E(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field70E(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 Field70E |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field70E object.
|
static Field70E |
get(SwiftMessage msg)
Gets the first instance of Field70E in the given message.
|
static Field70E |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field70E> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field70E in the given message
an empty list is returned if none found.
|
static java.util.List<Field70E> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field70E from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent10()
Gets the component 10 (Narrative).
|
java.lang.String |
getComponent11()
Gets the component 11 (Narrative).
|
java.lang.String |
getComponent2()
Gets the component 2 (Narrative).
|
java.lang.String |
getComponent3()
Gets the component 3 (Narrative).
|
java.lang.String |
getComponent4()
Gets the component 4 (Narrative).
|
java.lang.String |
getComponent5()
Gets the component 5 (Narrative).
|
java.lang.String |
getComponent6()
Gets the component 6 (Narrative).
|
java.lang.String |
getComponent7()
Gets the component 7 (Narrative).
|
java.lang.String |
getComponent8()
Gets the component 8 (Narrative).
|
java.lang.String |
getComponent9()
Gets the component 9 (Narrative).
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.
|
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
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()
Gets the Narrative as a concatenation of component 2 to component 11.
|
java.lang.String |
getNarrative(java.lang.CharSequence deli)
Gets the Narrative as a concatenation of component 2 to component 11 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getNarrativeLine1()
Gets the Narrative (component 2).
|
java.lang.String |
getNarrativeLine10()
Gets the Narrative (component 11).
|
java.lang.String |
getNarrativeLine2()
Gets the Narrative (component 3).
|
java.lang.String |
getNarrativeLine3()
Gets the Narrative (component 4).
|
java.lang.String |
getNarrativeLine4()
Gets the Narrative (component 5).
|
java.lang.String |
getNarrativeLine5()
Gets the Narrative (component 6).
|
java.lang.String |
getNarrativeLine6()
Gets the Narrative (component 7).
|
java.lang.String |
getNarrativeLine7()
Gets the Narrative (component 8).
|
java.lang.String |
getNarrativeLine8()
Gets the Narrative (component 9).
|
java.lang.String |
getNarrativeLine9()
Gets the Narrative (component 10).
|
java.lang.String |
getQualifier()
Gets the Qualifier (component 1).
|
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 |
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.
|
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 Field70E |
newInstance(Field70E 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
|
Field70E |
setComponent1(java.lang.String component1)
Set the component1 (Qualifier).
|
Field70E |
setComponent10(java.lang.String component10)
Set the component10 (Narrative).
|
Field70E |
setComponent11(java.lang.String component11)
Set the component11 (Narrative).
|
Field70E |
setComponent2(java.lang.String component2)
Set the component2 (Narrative).
|
Field70E |
setComponent3(java.lang.String component3)
Set the component3 (Narrative).
|
Field70E |
setComponent4(java.lang.String component4)
Set the component4 (Narrative).
|
Field70E |
setComponent5(java.lang.String component5)
Set the component5 (Narrative).
|
Field70E |
setComponent6(java.lang.String component6)
Set the component6 (Narrative).
|
Field70E |
setComponent7(java.lang.String component7)
Set the component7 (Narrative).
|
Field70E |
setComponent8(java.lang.String component8)
Set the component8 (Narrative).
|
Field70E |
setComponent9(java.lang.String component9)
Set the component9 (Narrative).
|
Field70E |
setNarrative(java.lang.String value)
Set the Narrative splitting the parameter lines into components 2 to 11.
|
Field70E |
setNarrativeLine1(java.lang.String component2)
Set the Narrative (component2).
|
Field70E |
setNarrativeLine10(java.lang.String component11)
Set the Narrative (component11).
|
Field70E |
setNarrativeLine2(java.lang.String component3)
Set the Narrative (component3).
|
Field70E |
setNarrativeLine3(java.lang.String component4)
Set the Narrative (component4).
|
Field70E |
setNarrativeLine4(java.lang.String component5)
Set the Narrative (component5).
|
Field70E |
setNarrativeLine5(java.lang.String component6)
Set the Narrative (component6).
|
Field70E |
setNarrativeLine6(java.lang.String component7)
Set the Narrative (component7).
|
Field70E |
setNarrativeLine7(java.lang.String component8)
Set the Narrative (component8).
|
Field70E |
setNarrativeLine8(java.lang.String component9)
Set the Narrative (component9).
|
Field70E |
setNarrativeLine9(java.lang.String component10)
Set the Narrative (component10).
|
Field70E |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
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
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, 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, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_70E
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer NARRATIVE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field70E()
public Field70E(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field70E(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field70E newInstance(Field70E 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
protected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.lang.String getNarrativeLine1()
public java.lang.String getNarrativeLine2()
public java.lang.String getNarrativeLine3()
public java.lang.String getNarrativeLine4()
public java.lang.String getNarrativeLine5()
public java.lang.String getNarrativeLine6()
public java.lang.String getNarrativeLine7()
public java.lang.String getNarrativeLine8()
public java.lang.String getNarrativeLine9()
public java.lang.String getNarrativeLine10()
public java.lang.String getNarrative()
public java.lang.String getNarrative(java.lang.CharSequence deli)
deli
- the delimiter that separates each componentpublic java.lang.String getComponent3()
public java.lang.String getComponent4()
public java.lang.String getComponent5()
public java.lang.String getComponent6()
public java.lang.String getComponent7()
public java.lang.String getComponent8()
public java.lang.String getComponent9()
public java.lang.String getComponent10()
public java.lang.String getComponent11()
public Field70E setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field70E setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field70E setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field70E setNarrativeLine1(java.lang.String component2)
component2
- the Narrative to setpublic Field70E setNarrativeLine2(java.lang.String component3)
component3
- the Narrative to setpublic Field70E setNarrativeLine3(java.lang.String component4)
component4
- the Narrative to setpublic Field70E setNarrativeLine4(java.lang.String component5)
component5
- the Narrative to setpublic Field70E setNarrativeLine5(java.lang.String component6)
component6
- the Narrative to setpublic Field70E setNarrativeLine6(java.lang.String component7)
component7
- the Narrative to setpublic Field70E setNarrativeLine7(java.lang.String component8)
component8
- the Narrative to setpublic Field70E setNarrativeLine8(java.lang.String component9)
component9
- the Narrative to setpublic Field70E setNarrativeLine9(java.lang.String component10)
component10
- the Narrative to setpublic Field70E setNarrativeLine10(java.lang.String component11)
component11
- the Narrative to setpublic Field70E setNarrative(java.lang.String value)
value
- the Narrative to set, may contain line ends and each line will be set to its correspondent component attributepublic Field70E setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field70E setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field70E setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field70E setComponent6(java.lang.String component6)
component6
- the component6 to setpublic Field70E setComponent7(java.lang.String component7)
component7
- the component7 to setpublic Field70E setComponent8(java.lang.String component8)
component8
- the component8 to setpublic Field70E setComponent9(java.lang.String component9)
component9
- the component9 to setpublic Field70E setComponent10(java.lang.String component10)
component10
- the component10 to setpublic Field70E setComponent11(java.lang.String component11)
component11
- the component11 to setpublic java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
public java.lang.String getName()
public static Field70E get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field70E get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field70E> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field70E> 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 Field70E fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)