@Generated public class Field343 extends Field implements java.io.Serializable
Model and parser for field 343 of a SWIFT MT message.
Subfields (components) Data types
Number
Number
Number
Number
Structure definition
5!n 5!n 5!n 5!n
N<SPACE>N<SPACE>N<SPACE>N
NNNN
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_343
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 343
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
REGION_TIME_COUNT_1
Component number for the Region Time Count 1 subfield
|
static java.lang.Integer |
REGION_TIME_COUNT_2
Component number for the Region Time Count 2 subfield
|
static java.lang.Integer |
REGION_TIME_COUNT_3
Component number for the Region Time Count 3 subfield
|
static java.lang.Integer |
REGION_TIME_COUNT_4
Component number for the Region Time Count 4 subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field343()
Default constructor.
|
Field343(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field343(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 Field343 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field343 object.
|
static Field343 |
get(SwiftMessage msg)
Gets the first instance of Field343 in the given message.
|
static Field343 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field343> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field343 in the given message
an empty list is returned if none found.
|
static java.util.List<Field343> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field343 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Region Time Count 1).
|
java.lang.Number |
getComponent1AsNumber()
Get the component 1 as Number
|
java.lang.String |
getComponent2()
Gets the component 2 (Region Time Count 2).
|
java.lang.Number |
getComponent2AsNumber()
Get the component 2 as Number
|
java.lang.String |
getComponent3()
Gets the component 3 (Region Time Count 3).
|
java.lang.Number |
getComponent3AsNumber()
Get the component 3 as Number
|
java.lang.String |
getComponent4()
Gets the component 4 (Region Time Count 4).
|
java.lang.Number |
getComponent4AsNumber()
Get the component 4 as Number
|
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 |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getRegionTimeCount1()
Gets the Region Time Count 1 (component 1).
|
java.lang.Number |
getRegionTimeCount1AsNumber()
Get the Region Time Count 1 (component 1) as Number
|
java.lang.String |
getRegionTimeCount2()
Gets the Region Time Count 2 (component 2).
|
java.lang.Number |
getRegionTimeCount2AsNumber()
Get the Region Time Count 2 (component 2) as Number
|
java.lang.String |
getRegionTimeCount3()
Gets the Region Time Count 3 (component 3).
|
java.lang.Number |
getRegionTimeCount3AsNumber()
Get the Region Time Count 3 (component 3) as Number
|
java.lang.String |
getRegionTimeCount4()
Gets the Region Time Count 4 (component 4).
|
java.lang.Number |
getRegionTimeCount4AsNumber()
Get the Region Time Count 4 (component 4) as Number
|
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 Field343 |
newInstance(Field343 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
|
Field343 |
setComponent1(java.lang.Number component1)
Set the component1 from a Number object.
|
Field343 |
setComponent1(java.lang.String component1)
Set the component1 (Region Time Count 1).
|
Field343 |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field343 |
setComponent2(java.lang.String component2)
Set the component2 (Region Time Count 2).
|
Field343 |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field343 |
setComponent3(java.lang.String component3)
Set the component3 (Region Time Count 3).
|
Field343 |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field343 |
setComponent4(java.lang.String component4)
Set the component4 (Region Time Count 4).
|
Field343 |
setRegionTimeCount1(java.lang.Number component1)
Set the Region Time Count 1 (component1) from a Number object.
|
Field343 |
setRegionTimeCount1(java.lang.String component1)
Set the Region Time Count 1 (component1).
|
Field343 |
setRegionTimeCount2(java.lang.Number component2)
Set the Region Time Count 2 (component2) from a Number object.
|
Field343 |
setRegionTimeCount2(java.lang.String component2)
Set the Region Time Count 2 (component2).
|
Field343 |
setRegionTimeCount3(java.lang.Number component3)
Set the Region Time Count 3 (component3) from a Number object.
|
Field343 |
setRegionTimeCount3(java.lang.String component3)
Set the Region Time Count 3 (component3).
|
Field343 |
setRegionTimeCount4(java.lang.Number component4)
Set the Region Time Count 4 (component4) from a Number object.
|
Field343 |
setRegionTimeCount4(java.lang.String component4)
Set the Region Time Count 4 (component4).
|
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, 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
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_343
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer REGION_TIME_COUNT_1
public static final java.lang.Integer REGION_TIME_COUNT_2
public static final java.lang.Integer REGION_TIME_COUNT_3
public static final java.lang.Integer REGION_TIME_COUNT_4
public Field343()
public Field343(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field343(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field343 newInstance(Field343 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.Number getComponent1AsNumber()
public java.lang.String getRegionTimeCount1()
public java.lang.Number getRegionTimeCount1AsNumber()
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getRegionTimeCount2()
public java.lang.Number getRegionTimeCount2AsNumber()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getRegionTimeCount3()
public java.lang.Number getRegionTimeCount3AsNumber()
public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getRegionTimeCount4()
public java.lang.Number getRegionTimeCount4AsNumber()
public Field343 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field343 setComponent1(java.lang.Number component1)
component1
- the Number with the component1 content to setsetComponent1(String)
public Field343 setRegionTimeCount1(java.lang.String component1)
component1
- the Region Time Count 1 to setpublic Field343 setRegionTimeCount1(java.lang.Number component1)
component1
- Number with the Region Time Count 1 content to setsetComponent1(java.lang.Number)
public Field343 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field343 setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field343 setRegionTimeCount2(java.lang.String component2)
component2
- the Region Time Count 2 to setpublic Field343 setRegionTimeCount2(java.lang.Number component2)
component2
- Number with the Region Time Count 2 content to setsetComponent2(java.lang.Number)
public Field343 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field343 setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field343 setRegionTimeCount3(java.lang.String component3)
component3
- the Region Time Count 3 to setpublic Field343 setRegionTimeCount3(java.lang.Number component3)
component3
- Number with the Region Time Count 3 content to setsetComponent3(java.lang.Number)
public Field343 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field343 setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field343 setRegionTimeCount4(java.lang.String component4)
component4
- the Region Time Count 4 to setpublic Field343 setRegionTimeCount4(java.lang.Number component4)
component4
- Number with the Region Time Count 4 content to setsetComponent4(java.lang.Number)
public java.lang.String getName()
public static Field343 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field343 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field343> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field343> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field343 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)