@Generated public class Field346 extends Field implements java.io.Serializable
Model and parser for field 346 of a SWIFT MT message.
Subfields (components) Data types
String
String
String
String
String
String
String
String
String
String
Structure definition
[3!c]*10
3!S*10
SSSSSSSSSS
This class complies with standard release SRU2023
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
BRANCH1
Component number for the Branch1 subfield.
|
static java.lang.Integer |
BRANCH10
Component number for the Branch10 subfield.
|
static java.lang.Integer |
BRANCH2
Component number for the Branch2 subfield.
|
static java.lang.Integer |
BRANCH3
Component number for the Branch3 subfield.
|
static java.lang.Integer |
BRANCH4
Component number for the Branch4 subfield.
|
static java.lang.Integer |
BRANCH5
Component number for the Branch5 subfield.
|
static java.lang.Integer |
BRANCH6
Component number for the Branch6 subfield.
|
static java.lang.Integer |
BRANCH7
Component number for the Branch7 subfield.
|
static java.lang.Integer |
BRANCH8
Component number for the Branch8 subfield.
|
static java.lang.Integer |
BRANCH9
Component number for the Branch9 subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_346
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 346.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
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, labelMap
Constructor and Description |
---|
Field346()
Default constructor.
|
Field346(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field346(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 Field346 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field346 object.
|
static Field346 |
get(SwiftMessage msg)
Gets the first instance of Field346 in the given message.
|
static Field346 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field346> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field346 in the given message
an empty list is returned if none found.
|
static java.util.List<Field346> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field346 from the given block
an empty list is returned if none found.
|
java.lang.String |
getBranch1()
Gets the Branch1 (component 1).
|
java.lang.String |
getBranch10()
Gets the Branch10 (component 10).
|
java.lang.String |
getBranch2()
Gets the Branch2 (component 2).
|
java.lang.String |
getBranch3()
Gets the Branch3 (component 3).
|
java.lang.String |
getBranch4()
Gets the Branch4 (component 4).
|
java.lang.String |
getBranch5()
Gets the Branch5 (component 5).
|
java.lang.String |
getBranch6()
Gets the Branch6 (component 6).
|
java.lang.String |
getBranch7()
Gets the Branch7 (component 7).
|
java.lang.String |
getBranch8()
Gets the Branch8 (component 8).
|
java.lang.String |
getBranch9()
Gets the Branch9 (component 9).
|
java.lang.String |
getComponent1()
Gets the component 1 (Branch1).
|
java.lang.String |
getComponent10()
Gets the component 10 (Branch10).
|
java.lang.String |
getComponent2()
Gets the component 2 (Branch2).
|
java.lang.String |
getComponent3()
Gets the component 3 (Branch3).
|
java.lang.String |
getComponent4()
Gets the component 4 (Branch4).
|
java.lang.String |
getComponent5()
Gets the component 5 (Branch5).
|
java.lang.String |
getComponent6()
Gets the component 6 (Branch6).
|
java.lang.String |
getComponent7()
Gets the component 7 (Branch7).
|
java.lang.String |
getComponent8()
Gets the component 8 (Branch8).
|
java.lang.String |
getComponent9()
Gets the component 9 (Branch9).
|
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.
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
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 Field346 |
newInstance(Field346 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.
|
Field346 |
setBranch1(java.lang.String component1)
Set the Branch1 (component 1).
|
Field346 |
setBranch10(java.lang.String component10)
Set the Branch10 (component 10).
|
Field346 |
setBranch2(java.lang.String component2)
Set the Branch2 (component 2).
|
Field346 |
setBranch3(java.lang.String component3)
Set the Branch3 (component 3).
|
Field346 |
setBranch4(java.lang.String component4)
Set the Branch4 (component 4).
|
Field346 |
setBranch5(java.lang.String component5)
Set the Branch5 (component 5).
|
Field346 |
setBranch6(java.lang.String component6)
Set the Branch6 (component 6).
|
Field346 |
setBranch7(java.lang.String component7)
Set the Branch7 (component 7).
|
Field346 |
setBranch8(java.lang.String component8)
Set the Branch8 (component 8).
|
Field346 |
setBranch9(java.lang.String component9)
Set the Branch9 (component 9).
|
Field346 |
setComponent1(java.lang.String component1)
Set the component 1 (Branch1).
|
Field346 |
setComponent10(java.lang.String component10)
Set the component 10 (Branch10).
|
Field346 |
setComponent2(java.lang.String component2)
Set the component 2 (Branch2).
|
Field346 |
setComponent3(java.lang.String component3)
Set the component 3 (Branch3).
|
Field346 |
setComponent4(java.lang.String component4)
Set the component 4 (Branch4).
|
Field346 |
setComponent5(java.lang.String component5)
Set the component 5 (Branch5).
|
Field346 |
setComponent6(java.lang.String component6)
Set the component 6 (Branch6).
|
Field346 |
setComponent7(java.lang.String component7)
Set the component 7 (Branch7).
|
Field346 |
setComponent8(java.lang.String component8)
Set the component 8 (Branch8).
|
Field346 |
setComponent9(java.lang.String component9)
Set the component 9 (Branch9).
|
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, 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, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_346
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer BRANCH1
public static final java.lang.Integer BRANCH2
public static final java.lang.Integer BRANCH3
public static final java.lang.Integer BRANCH4
public static final java.lang.Integer BRANCH5
public static final java.lang.Integer BRANCH6
public static final java.lang.Integer BRANCH7
public static final java.lang.Integer BRANCH8
public static final java.lang.Integer BRANCH9
public static final java.lang.Integer BRANCH10
public Field346()
public Field346(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field346(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field346 newInstance(Field346 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(phase4=SRU2024) 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getBranch1()
public java.lang.String getComponent2()
public java.lang.String getBranch2()
public java.lang.String getComponent3()
public java.lang.String getBranch3()
public java.lang.String getComponent4()
public java.lang.String getBranch4()
public java.lang.String getComponent5()
public java.lang.String getBranch5()
public java.lang.String getComponent6()
public java.lang.String getBranch6()
public java.lang.String getComponent7()
public java.lang.String getBranch7()
public java.lang.String getComponent8()
public java.lang.String getBranch8()
public java.lang.String getComponent9()
public java.lang.String getBranch9()
public java.lang.String getComponent10()
public java.lang.String getBranch10()
public Field346 setComponent1(java.lang.String component1)
component1
- the Branch1 to setpublic Field346 setBranch1(java.lang.String component1)
component1
- the Branch1 to setpublic Field346 setComponent2(java.lang.String component2)
component2
- the Branch2 to setpublic Field346 setBranch2(java.lang.String component2)
component2
- the Branch2 to setpublic Field346 setComponent3(java.lang.String component3)
component3
- the Branch3 to setpublic Field346 setBranch3(java.lang.String component3)
component3
- the Branch3 to setpublic Field346 setComponent4(java.lang.String component4)
component4
- the Branch4 to setpublic Field346 setBranch4(java.lang.String component4)
component4
- the Branch4 to setpublic Field346 setComponent5(java.lang.String component5)
component5
- the Branch5 to setpublic Field346 setBranch5(java.lang.String component5)
component5
- the Branch5 to setpublic Field346 setComponent6(java.lang.String component6)
component6
- the Branch6 to setpublic Field346 setBranch6(java.lang.String component6)
component6
- the Branch6 to setpublic Field346 setComponent7(java.lang.String component7)
component7
- the Branch7 to setpublic Field346 setBranch7(java.lang.String component7)
component7
- the Branch7 to setpublic Field346 setComponent8(java.lang.String component8)
component8
- the Branch8 to setpublic Field346 setBranch8(java.lang.String component8)
component8
- the Branch8 to setpublic Field346 setComponent9(java.lang.String component9)
component9
- the Branch9 to setpublic Field346 setBranch9(java.lang.String component9)
component9
- the Branch9 to setpublic Field346 setComponent10(java.lang.String component10)
component10
- the Branch10 to setpublic Field346 setBranch10(java.lang.String component10)
component10
- the Branch10 to setpublic java.lang.String getName()
public static Field346 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field346 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field346> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field346> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field346 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)