@Generated public class Field35B extends Field implements java.io.Serializable, MultiLineField
Model and parser for field 35B of a SWIFT MT message.
Subfields (components) Data types
String
String
String
String
String
String
Structure definition
[<ISIN> 12!c][$][35x][$35x]0-3(****)
[<ISIN><SPACE>S][$S]0-4
SSSSSS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
DESCRIPTION
Component number for the Description subfield.
|
static java.lang.Integer |
DESCRIPTION_OF_INSTRUMENT
Alternative constant name for field's Description Component number.
|
static java.lang.Integer |
DESCRIPTION_OF_SECURITY
Alternative constant name for field's Description Component number.
|
static java.lang.String |
F_35B
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
IDENTIFICATION_OF_INSTRUMENT
Alternative constant name for field's ISIN Component number.
|
static java.lang.Integer |
IDENTIFICATION_OF_SECURITY
Alternative constant name for field's ISIN Component number.
|
static java.lang.Integer |
ISIN
Component number for the ISIN subfield.
|
static java.lang.String |
NAME
Constant with the field name 35B.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field35B()
Default constructor.
|
Field35B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field35B(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()
Deprecated.
Use
typesPattern() instead. |
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.
|
static Field35B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field35B object.
|
static Field35B |
get(SwiftMessage msg)
Gets the first instance of Field35B in the given message.
|
static Field35B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field35B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field35B in the given message
an empty list is returned if none found.
|
static java.util.List<Field35B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field35B from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (ISIN).
|
java.lang.String |
getComponent3()
Gets the component 3 (Description).
|
java.lang.String |
getComponent4()
Gets the component 4 (Description 2).
|
java.lang.String |
getComponent5()
Gets the component 5 (Description 3).
|
java.lang.String |
getComponent6()
Gets the component 6 (Description 4).
|
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 |
getDescription()
Gets the Description as a concatenation of component 3 to component 6.
|
java.lang.String |
getDescription(java.lang.CharSequence deli)
Gets the Description as a concatenation of component 3 to component 6 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getDescriptionLine1()
Gets the Description (component 3).
|
java.lang.String |
getDescriptionLine2()
Gets the Description 2 (component 4).
|
java.lang.String |
getDescriptionLine3()
Gets the Description 3 (component 5).
|
java.lang.String |
getDescriptionLine4()
Gets the Description 4 (component 6).
|
java.lang.String |
getDescriptionOfInstrument()
Alternative method getter for concatenation
of component 3 to component 6 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getDescriptionOfInstrument(java.lang.CharSequence deli)
Alternative method getter for concatenation
of component 3 to component 6 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getDescriptionOfInstrumentLine1()
Alternative method getter for field's Description
|
java.lang.String |
getDescriptionOfInstrumentLine2()
Alternative method getter for field's Description 2
|
java.lang.String |
getDescriptionOfInstrumentLine3()
Alternative method getter for field's Description 3
|
java.lang.String |
getDescriptionOfInstrumentLine4()
Alternative method getter for field's Description 4
|
java.lang.String |
getDescriptionOfSecurity()
Alternative method getter for concatenation
of component 3 to component 6 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getDescriptionOfSecurity(java.lang.CharSequence deli)
Alternative method getter for concatenation
of component 3 to component 6 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getDescriptionOfSecurityLine1()
Alternative method getter for field's Description
|
java.lang.String |
getDescriptionOfSecurityLine2()
Alternative method getter for field's Description 2
|
java.lang.String |
getDescriptionOfSecurityLine3()
Alternative method getter for field's Description 3
|
java.lang.String |
getDescriptionOfSecurityLine4()
Alternative method getter for field's Description 4
|
java.lang.String |
getIdentificationOfInstrument()
Alternative method getter for field's ISIN
|
java.lang.String |
getIdentificationOfSecurity()
Alternative method getter for field's ISIN
|
java.lang.String |
getISIN()
Gets the ISIN (component 2).
|
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 |
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 |
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 Field35B |
newInstance(Field35B source)
Copy constructor.
|
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern.
|
Field35B |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field35B |
setComponent2(java.lang.String component2)
Set the component 2 (ISIN).
|
Field35B |
setComponent3(java.lang.String component3)
Set the component 3 (Description).
|
Field35B |
setComponent4(java.lang.String component4)
Set the component 4 (Description 2).
|
Field35B |
setComponent5(java.lang.String component5)
Set the component 5 (Description 3).
|
Field35B |
setComponent6(java.lang.String component6)
Set the component 6 (Description 4).
|
Field35B |
setDescription(java.lang.String value)
Set the Description splitting the parameter lines into components 3 to 6.
|
Field35B |
setDescriptionLine1(java.lang.String component3)
Set the Description (component 3).
|
Field35B |
setDescriptionLine2(java.lang.String component4)
Set the Description 2 (component 4).
|
Field35B |
setDescriptionLine3(java.lang.String component5)
Set the Description 3 (component 5).
|
Field35B |
setDescriptionLine4(java.lang.String component6)
Set the Description 4 (component 6).
|
Field35B |
setDescriptionOfInstrument(java.lang.String value)
Alternative method setter for
the Description splitting the parameter lines into components 3 to 6.
|
Field35B |
setDescriptionOfInstrumentLine1(java.lang.String component3)
Alternative method setter for field's Description
|
Field35B |
setDescriptionOfInstrumentLine2(java.lang.String component4)
Alternative method setter for field's Description 2
|
Field35B |
setDescriptionOfInstrumentLine3(java.lang.String component5)
Alternative method setter for field's Description 3
|
Field35B |
setDescriptionOfInstrumentLine4(java.lang.String component6)
Alternative method setter for field's Description 4
|
Field35B |
setDescriptionOfSecurity(java.lang.String value)
Alternative method setter for
the Description splitting the parameter lines into components 3 to 6.
|
Field35B |
setDescriptionOfSecurityLine1(java.lang.String component3)
Alternative method setter for field's Description
|
Field35B |
setDescriptionOfSecurityLine2(java.lang.String component4)
Alternative method setter for field's Description 2
|
Field35B |
setDescriptionOfSecurityLine3(java.lang.String component5)
Alternative method setter for field's Description 3
|
Field35B |
setDescriptionOfSecurityLine4(java.lang.String component6)
Alternative method setter for field's Description 4
|
Field35B |
setIdentificationOfInstrument(java.lang.String component2)
Alternative method setter for field's ISIN
|
Field35B |
setIdentificationOfSecurity(java.lang.String component2)
Alternative method setter for field's ISIN
|
Field35B |
setISIN(java.lang.String component2)
Set the ISIN (component 2).
|
Field35B |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Returns the field component types pattern.
|
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_35B
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer ISIN
public static final java.lang.Integer IDENTIFICATION_OF_INSTRUMENT
ISIN
public static final java.lang.Integer IDENTIFICATION_OF_SECURITY
ISIN
public static final java.lang.Integer DESCRIPTION
public static final java.lang.Integer DESCRIPTION_OF_INSTRUMENT
DESCRIPTION
public static final java.lang.Integer DESCRIPTION_OF_SECURITY
DESCRIPTION
public Field35B()
public Field35B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field35B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field35B newInstance(Field35B 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 field@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public 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.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 getISIN()
public java.lang.String getIdentificationOfInstrument()
getISIN()
public java.lang.String getIdentificationOfSecurity()
getISIN()
public java.lang.String getComponent3()
public java.lang.String getDescriptionLine1()
public java.lang.String getDescriptionOfInstrumentLine1()
getDescriptionLine1()
public java.lang.String getDescriptionOfSecurityLine1()
getDescriptionLine1()
public java.lang.String getDescription()
public java.lang.String getDescription(java.lang.CharSequence deli)
deli
- the delimiter that separates each componentpublic java.lang.String getDescriptionOfInstrument()
getDescription()
public java.lang.String getDescriptionOfInstrument(java.lang.CharSequence deli)
deli
- the delimiter that separates each componentgetDescription()
public java.lang.String getDescriptionOfSecurity()
getDescription()
public java.lang.String getDescriptionOfSecurity(java.lang.CharSequence deli)
deli
- the delimiter that separates each componentgetDescription()
public java.lang.String getComponent4()
public java.lang.String getDescriptionLine2()
public java.lang.String getDescriptionOfInstrumentLine2()
getDescriptionLine2()
public java.lang.String getDescriptionOfSecurityLine2()
getDescriptionLine2()
public java.lang.String getComponent5()
public java.lang.String getDescriptionLine3()
public java.lang.String getDescriptionOfInstrumentLine3()
getDescriptionLine3()
public java.lang.String getDescriptionOfSecurityLine3()
getDescriptionLine3()
public java.lang.String getComponent6()
public java.lang.String getDescriptionLine4()
public java.lang.String getDescriptionOfInstrumentLine4()
getDescriptionLine4()
public java.lang.String getDescriptionOfSecurityLine4()
getDescriptionLine4()
public Field35B setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field35B setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field35B setComponent2(java.lang.String component2)
component2
- the ISIN to setpublic Field35B setISIN(java.lang.String component2)
component2
- the ISIN to setpublic Field35B setIdentificationOfInstrument(java.lang.String component2)
component2
- the ISIN to setsetISIN(String)
public Field35B setIdentificationOfSecurity(java.lang.String component2)
component2
- the ISIN to setsetISIN(String)
public Field35B setComponent3(java.lang.String component3)
component3
- the Description to setpublic Field35B setDescriptionLine1(java.lang.String component3)
component3
- the Description to setpublic Field35B setDescriptionOfInstrumentLine1(java.lang.String component3)
component3
- the Description to setsetDescriptionLine1(String)
public Field35B setDescriptionOfSecurityLine1(java.lang.String component3)
component3
- the Description to setsetDescriptionLine1(String)
public Field35B setDescription(java.lang.String value)
value
- the Description to set, may contain line ends and each line will be set to its correspondent component attributepublic Field35B setDescriptionOfInstrument(java.lang.String value)
value
- the Description to set, may contain line ends and each line will be set to its correspondent component attributesetDescription(String)
public Field35B setDescriptionOfSecurity(java.lang.String value)
value
- the Description to set, may contain line ends and each line will be set to its correspondent component attributesetDescription(String)
public Field35B setComponent4(java.lang.String component4)
component4
- the Description 2 to setpublic Field35B setDescriptionLine2(java.lang.String component4)
component4
- the Description 2 to setpublic Field35B setDescriptionOfInstrumentLine2(java.lang.String component4)
component4
- the Description 2 to setsetDescriptionLine2(String)
public Field35B setDescriptionOfSecurityLine2(java.lang.String component4)
component4
- the Description 2 to setsetDescriptionLine2(String)
public Field35B setComponent5(java.lang.String component5)
component5
- the Description 3 to setpublic Field35B setDescriptionLine3(java.lang.String component5)
component5
- the Description 3 to setpublic Field35B setDescriptionOfInstrumentLine3(java.lang.String component5)
component5
- the Description 3 to setsetDescriptionLine3(String)
public Field35B setDescriptionOfSecurityLine3(java.lang.String component5)
component5
- the Description 3 to setsetDescriptionLine3(String)
public Field35B setComponent6(java.lang.String component6)
component6
- the Description 4 to setpublic Field35B setDescriptionLine4(java.lang.String component6)
component6
- the Description 4 to setpublic Field35B setDescriptionOfInstrumentLine4(java.lang.String component6)
component6
- the Description 4 to setsetDescriptionLine4(String)
public Field35B setDescriptionOfSecurityLine4(java.lang.String component6)
component6
- the Description 4 to setsetDescriptionLine4(String)
public java.lang.String getName()
public static Field35B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field35B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field35B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field35B> 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 Field35B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)